Class: Vapi::WebhookCredential

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider:, authentication_plan:, id:, org_id:, created_at:, updated_at:, authentication_session:, name: OMIT, additional_properties: nil) ⇒ Vapi::WebhookCredential

Parameters:

  • provider (String)
  • authentication_plan (Vapi::WebhookCredentialAuthenticationPlan) —

    This is the authentication plan. Supports OAuth2 RFC 6749 and HMAC signing.

  • 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.

  • authentication_session (Vapi::Oauth2AuthenticationSession) —

    This is the authentication session for the credential. Available for credentials that have an authentication plan.

  • 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



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

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



29
30
31
 
# File 'lib/vapi_server_sdk/types/webhook_credential.rb', line 29

def additional_properties
  @additional_properties
end

#authentication_plan ⇒ Vapi::WebhookCredentialAuthenticationPlan (readonly)

Returns This is the authentication plan. Supports OAuth2 RFC 6749 and HMAC signing.

Returns:



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

def authentication_plan
  @authentication_plan
end

#authentication_session ⇒ Vapi::Oauth2AuthenticationSession (readonly)

Returns This is the authentication session for the credential. Available for credentials that have an authentication plan.

Returns:



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

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



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

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.



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

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.



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

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.



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

def org_id
  @org_id
end

#provider ⇒ String (readonly)

Returns:

  • (String) 


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

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.



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

def updated_at
  @updated_at
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::WebhookCredential

Deserialize a JSON object to an instance of WebhookCredential

Parameters:

  • json_object (String)

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/vapi_server_sdk/types/webhook_credential.rb', line 76

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  provider = parsed_json["provider"]
  if parsed_json["authenticationPlan"].nil?
    authentication_plan = nil
  else
    authentication_plan = parsed_json["authenticationPlan"].to_json
    authentication_plan = Vapi::WebhookCredentialAuthenticationPlan.from_json(json_object: authentication_plan)
  end
  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?)
  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(
    provider: provider,
    authentication_plan: authentication_plan,
    id: id,
    org_id: org_id,
    created_at: created_at,
    updated_at: updated_at,
    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) 


123
124
125
126
127
128
129
130
131
132
 
# File 'lib/vapi_server_sdk/types/webhook_credential.rb', line 123

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.")
  Vapi::WebhookCredentialAuthenticationPlan.validate_raw(obj: obj.authentication_plan)
  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.")
  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 WebhookCredential to a JSON object

Returns:

  • (String) 


113
114
115
 
# File 'lib/vapi_server_sdk/types/webhook_credential.rb', line 113

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