Class: Vapi::UpdatePlayHtCredentialDto

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key: OMIT, name: OMIT, user_id: OMIT, additional_properties: nil) ⇒ Vapi::UpdatePlayHtCredentialDto

Parameters:

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

    This is not returned in the API.

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

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

  • user_id (String) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



27
28
29
30
31
32
33
34
35
 
# File 'lib/vapi_server_sdk/types/update_play_ht_credential_dto.rb', line 27

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



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

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.



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

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



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

def name
  @name
end

#user_id ⇒ String (readonly)

Returns:

  • (String) 


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

def user_id
  @user_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::UpdatePlayHtCredentialDto

Deserialize a JSON object to an instance of UpdatePlayHtCredentialDto

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  api_key = parsed_json["apiKey"]
  name = parsed_json["name"]
  user_id = parsed_json["userId"]
  new(
    api_key: api_key,
    name: name,
    user_id: user_id,
    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
72
 
# File 'lib/vapi_server_sdk/types/update_play_ht_credential_dto.rb', line 68

def self.validate_raw(obj:)
  obj.api_key&.is_a?(String) != false || raise("Passed value for field obj.api_key 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.user_id&.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of UpdatePlayHtCredentialDto to a JSON object

Returns:

  • (String) 


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

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