Class: Vapi::ImportTwilioPhoneNumberDto
- Inherits:
-
Object
- Object
- Vapi::ImportTwilioPhoneNumberDto
- Defined in:
- lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb
Constant Summary collapse
- OMIT =
Object.new
Instance Attribute Summary collapse
-
#additional_properties ⇒ OpenStruct
readonly
Additional properties unmapped to the current class definition.
-
#assistant_id ⇒ String
readonly
This is the assistant that will be used for incoming calls to this phone number.
-
#fallback_destination ⇒ Vapi::ImportTwilioPhoneNumberDtoFallbackDestination
readonly
This is the fallback destination an inbound call will be transferred to if: 1.
-
#name ⇒ String
readonly
This is the name of the phone number.
-
#server_url ⇒ String
readonly
This is the server URL where messages will be sent for calls on this number.
-
#server_url_secret ⇒ String
readonly
This is the secret Vapi will send with every message to your server.
-
#squad_id ⇒ String
readonly
This is the squad that will be used for incoming calls to this phone number.
-
#twilio_account_sid ⇒ String
readonly
This is your Twilio Account SID that will be used to handle this phone number.
-
#twilio_auth_token ⇒ String
readonly
This is the Twilio Auth Token that will be used to handle this phone number.
-
#twilio_phone_number ⇒ String
readonly
These are the digits of the phone number you own on your Twilio.
Class Method Summary collapse
-
.from_json(json_object:) ⇒ Vapi::ImportTwilioPhoneNumberDto
Deserialize a JSON object to an instance of ImportTwilioPhoneNumberDto.
-
.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.
Instance Method Summary collapse
- #initialize(twilio_phone_number:, twilio_account_sid:, twilio_auth_token:, fallback_destination: OMIT, name: OMIT, assistant_id: OMIT, squad_id: OMIT, server_url: OMIT, server_url_secret: OMIT, additional_properties: nil) ⇒ Vapi::ImportTwilioPhoneNumberDto constructor
-
#to_json(*_args) ⇒ String
Serialize an instance of ImportTwilioPhoneNumberDto to a JSON object.
Constructor Details
#initialize(twilio_phone_number:, twilio_account_sid:, twilio_auth_token:, fallback_destination: OMIT, name: OMIT, assistant_id: OMIT, squad_id: OMIT, server_url: OMIT, server_url_secret: OMIT, additional_properties: nil) ⇒ Vapi::ImportTwilioPhoneNumberDto
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 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 80 def initialize(twilio_phone_number:, twilio_account_sid:, twilio_auth_token:, fallback_destination: OMIT, name: OMIT, assistant_id: OMIT, squad_id: OMIT, server_url: OMIT, server_url_secret: OMIT, additional_properties: nil) @fallback_destination = fallback_destination if fallback_destination != OMIT @twilio_phone_number = twilio_phone_number @twilio_account_sid = twilio_account_sid @twilio_auth_token = twilio_auth_token @name = name if name != OMIT @assistant_id = assistant_id if assistant_id != OMIT @squad_id = squad_id if squad_id != OMIT @server_url = server_url if server_url != OMIT @server_url_secret = server_url_secret if server_url_secret != OMIT @additional_properties = additional_properties @_field_set = { "fallbackDestination": fallback_destination, "twilioPhoneNumber": twilio_phone_number, "twilioAccountSid": twilio_account_sid, "twilioAuthToken": twilio_auth_token, "name": name, "assistantId": assistant_id, "squadId": squad_id, "serverUrl": server_url, "serverUrlSecret": server_url_secret }.reject do |_k, v| v == OMIT end end |
Instance Attribute Details
#additional_properties ⇒ OpenStruct (readonly)
Returns Additional properties unmapped to the current class definition.
45 46 47 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 45 def additional_properties @additional_properties end |
#assistant_id ⇒ String (readonly)
Returns This is the assistant that will be used for incoming calls to this phone number. If neither ‘assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.
28 29 30 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 28 def assistant_id @assistant_id end |
#fallback_destination ⇒ Vapi::ImportTwilioPhoneNumberDtoFallbackDestination (readonly)
Returns This is the fallback destination an inbound call will be transferred to if:
-
‘assistantId` is not set
-
‘squadId` is not set
-
and, ‘assistant-request` message to the `serverUrl` fails
If this is not set and above conditions are met, the inbound call is hung up with an error message.
15 16 17 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 15 def fallback_destination @fallback_destination end |
#name ⇒ String (readonly)
Returns This is the name of the phone number. This is just for your own reference.
23 24 25 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 23 def name @name end |
#server_url ⇒ String (readonly)
Returns This is the server URL where messages will be sent for calls on this number. This includes the ‘assistant-request` message. You can see the shape of the messages sent in `ServerMessage`. This overrides the `org.serverUrl`. Order of precedence: tool.server.url > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.
39 40 41 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 39 def server_url @server_url end |
#server_url_secret ⇒ String (readonly)
Returns This is the secret Vapi will send with every message to your server. It’s sent as a header called x-vapi-secret. Same precedence logic as serverUrl.
43 44 45 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 43 def server_url_secret @server_url_secret end |
#squad_id ⇒ String (readonly)
Returns This is the squad that will be used for incoming calls to this phone number. If neither ‘assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected.
33 34 35 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 33 def squad_id @squad_id end |
#twilio_account_sid ⇒ String (readonly)
Returns This is your Twilio Account SID that will be used to handle this phone number.
19 20 21 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 19 def twilio_account_sid @twilio_account_sid end |
#twilio_auth_token ⇒ String (readonly)
Returns This is the Twilio Auth Token that will be used to handle this phone number.
21 22 23 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 21 def twilio_auth_token @twilio_auth_token end |
#twilio_phone_number ⇒ String (readonly)
Returns These are the digits of the phone number you own on your Twilio.
17 18 19 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 17 def twilio_phone_number @twilio_phone_number end |
Class Method Details
.from_json(json_object:) ⇒ Vapi::ImportTwilioPhoneNumberDto
Deserialize a JSON object to an instance of ImportTwilioPhoneNumberDto
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 111 def self.from_json(json_object:) struct = JSON.parse(json_object, object_class: OpenStruct) parsed_json = JSON.parse(json_object) if parsed_json["fallbackDestination"].nil? fallback_destination = nil else fallback_destination = parsed_json["fallbackDestination"].to_json fallback_destination = Vapi::ImportTwilioPhoneNumberDtoFallbackDestination.from_json(json_object: fallback_destination) end twilio_phone_number = parsed_json["twilioPhoneNumber"] twilio_account_sid = parsed_json["twilioAccountSid"] twilio_auth_token = parsed_json["twilioAuthToken"] name = parsed_json["name"] assistant_id = parsed_json["assistantId"] squad_id = parsed_json["squadId"] server_url = parsed_json["serverUrl"] server_url_secret = parsed_json["serverUrlSecret"] new( fallback_destination: fallback_destination, twilio_phone_number: twilio_phone_number, twilio_account_sid: twilio_account_sid, twilio_auth_token: twilio_auth_token, name: name, assistant_id: assistant_id, squad_id: squad_id, server_url: server_url, server_url_secret: server_url_secret, 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.
155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 155 def self.validate_raw(obj:) obj.fallback_destination.nil? || Vapi::ImportTwilioPhoneNumberDtoFallbackDestination.validate_raw(obj: obj.fallback_destination) obj.twilio_phone_number.is_a?(String) != false || raise("Passed value for field obj.twilio_phone_number is not the expected type, validation failed.") obj.twilio_account_sid.is_a?(String) != false || raise("Passed value for field obj.twilio_account_sid is not the expected type, validation failed.") obj.twilio_auth_token.is_a?(String) != false || raise("Passed value for field obj.twilio_auth_token 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.assistant_id&.is_a?(String) != false || raise("Passed value for field obj.assistant_id is not the expected type, validation failed.") obj.squad_id&.is_a?(String) != false || raise("Passed value for field obj.squad_id is not the expected type, validation failed.") obj.server_url&.is_a?(String) != false || raise("Passed value for field obj.server_url is not the expected type, validation failed.") obj.server_url_secret&.is_a?(String) != false || raise("Passed value for field obj.server_url_secret is not the expected type, validation failed.") end |
Instance Method Details
#to_json(*_args) ⇒ String
Serialize an instance of ImportTwilioPhoneNumberDto to a JSON object
145 146 147 |
# File 'lib/vapi_server_sdk/types/import_twilio_phone_number_dto.rb', line 145 def to_json(*_args) @_field_set&.to_json end |