Class: Vapi::CredentialWebhookDto

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, operation:, from:, connection_id:, auth_mode:, provider_config_key:, provider:, environment:, success:, end_user:, error: OMIT, additional_properties: nil) ⇒ Vapi::CredentialWebhookDto

Parameters:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/vapi_server_sdk/types/credential_webhook_dto.rb', line 56

def initialize(type:, operation:, from:, connection_id:, auth_mode:, provider_config_key:, provider:, environment:,
               success:, end_user:, error: OMIT, additional_properties: nil)
  @type = type
  @operation = operation
  @from = from
  @connection_id = connection_id
  @auth_mode = auth_mode
  @provider_config_key = provider_config_key
  @provider = provider
  @environment = environment
  @success = success
  @end_user = end_user
  @error = error if error != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "type": type,
    "operation": operation,
    "from": from,
    "connectionId": connection_id,
    "authMode": auth_mode,
    "providerConfigKey": provider_config_key,
    "provider": provider,
    "environment": environment,
    "success": success,
    "endUser": end_user,
    "error": error
  }.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



36
37
38
 
# File 'lib/vapi_server_sdk/types/credential_webhook_dto.rb', line 36

def additional_properties
  @additional_properties
end

#auth_mode ⇒ Vapi::CredentialWebhookDtoAuthMode (readonly)

Returns:



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

def auth_mode
  @auth_mode
end

#connection_id ⇒ String (readonly)

Returns:

  • (String) 


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

def connection_id
  @connection_id
end

#end_user ⇒ Vapi::CredentialEndUser (readonly)

Returns:



32
33
34
 
# File 'lib/vapi_server_sdk/types/credential_webhook_dto.rb', line 32

def end_user
  @end_user
end

#environment ⇒ String (readonly)

Returns:

  • (String) 


28
29
30
 
# File 'lib/vapi_server_sdk/types/credential_webhook_dto.rb', line 28

def environment
  @environment
end

#error ⇒ Vapi::CredentialSessionError (readonly)

Returns:



34
35
36
 
# File 'lib/vapi_server_sdk/types/credential_webhook_dto.rb', line 34

def error
  @error
end

#from ⇒ String (readonly)

Returns:

  • (String) 


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

def from
  @from
end

#operation ⇒ Vapi::CredentialWebhookDtoOperation (readonly)

Returns:



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

def operation
  @operation
end

#provider ⇒ String (readonly)

Returns:

  • (String) 


26
27
28
 
# File 'lib/vapi_server_sdk/types/credential_webhook_dto.rb', line 26

def provider
  @provider
end

#provider_config_key ⇒ String (readonly)

Returns:

  • (String) 


24
25
26
 
# File 'lib/vapi_server_sdk/types/credential_webhook_dto.rb', line 24

def provider_config_key
  @provider_config_key
end

#success ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/vapi_server_sdk/types/credential_webhook_dto.rb', line 30

def success
  @success
end

#type ⇒ Vapi::CredentialWebhookDtoType (readonly)

Returns:



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

def type
  @type
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::CredentialWebhookDto

Deserialize a JSON object to an instance of CredentialWebhookDto

Parameters:

  • json_object (String)

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/vapi_server_sdk/types/credential_webhook_dto.rb', line 91

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  type = parsed_json["type"]
  operation = parsed_json["operation"]
  from = parsed_json["from"]
  connection_id = parsed_json["connectionId"]
  auth_mode = parsed_json["authMode"]
  provider_config_key = parsed_json["providerConfigKey"]
  provider = parsed_json["provider"]
  environment = parsed_json["environment"]
  success = parsed_json["success"]
  if parsed_json["endUser"].nil?
    end_user = nil
  else
    end_user = parsed_json["endUser"].to_json
    end_user = Vapi::CredentialEndUser.from_json(json_object: end_user)
  end
  if parsed_json["error"].nil?
    error = nil
  else
    error = parsed_json["error"].to_json
    error = Vapi::CredentialSessionError.from_json(json_object: error)
  end
  new(
    type: type,
    operation: operation,
    from: from,
    connection_id: connection_id,
    auth_mode: auth_mode,
    provider_config_key: provider_config_key,
    provider: provider,
    environment: environment,
    success: success,
    end_user: end_user,
    error: error,
    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) 


144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/vapi_server_sdk/types/credential_webhook_dto.rb', line 144

def self.validate_raw(obj:)
  obj.type.is_a?(Vapi::CredentialWebhookDtoType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
  obj.operation.is_a?(Vapi::CredentialWebhookDtoOperation) != false || raise("Passed value for field obj.operation is not the expected type, validation failed.")
  obj.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
  obj.connection_id.is_a?(String) != false || raise("Passed value for field obj.connection_id is not the expected type, validation failed.")
  obj.auth_mode.is_a?(Vapi::CredentialWebhookDtoAuthMode) != false || raise("Passed value for field obj.auth_mode is not the expected type, validation failed.")
  obj.provider_config_key.is_a?(String) != false || raise("Passed value for field obj.provider_config_key is not the expected type, validation failed.")
  obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
  obj.environment.is_a?(String) != false || raise("Passed value for field obj.environment is not the expected type, validation failed.")
  obj.success.is_a?(Boolean) != false || raise("Passed value for field obj.success is not the expected type, validation failed.")
  Vapi::CredentialEndUser.validate_raw(obj: obj.end_user)
  obj.error.nil? || Vapi::CredentialSessionError.validate_raw(obj: obj.error)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of CredentialWebhookDto to a JSON object

Returns:

  • (String) 


134
135
136
 
# File 'lib/vapi_server_sdk/types/credential_webhook_dto.rb', line 134

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