Class: Vapi::UpdateTwilioPhoneNumberDto

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(fallback_destination: OMIT, hooks: OMIT, sms_enabled: OMIT, name: OMIT, assistant_id: OMIT, workflow_id: OMIT, squad_id: OMIT, server: OMIT, number: OMIT, twilio_account_sid: OMIT, twilio_auth_token: OMIT, twilio_api_key: OMIT, twilio_api_secret: OMIT, additional_properties: nil) ⇒ Vapi::UpdateTwilioPhoneNumberDto

Parameters:

  • fallback_destination (Vapi::UpdateTwilioPhoneNumberDtoFallbackDestination) (defaults to: OMIT) —

    This is the fallback destination an inbound call will be transferred to if:

    1. ‘assistantId` is not set

    2. ‘squadId` is not set

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

  • hooks (Array<Vapi::PhoneNumberHookCallRinging>) (defaults to: OMIT) —

    This is the hooks that will be used for incoming calls to this phone number.

  • sms_enabled (Boolean) (defaults to: OMIT) —

    Controls whether Vapi sets the messaging webhook URL on the Twilio number during import. If set to ‘false`, Vapi will not update the Twilio messaging URL, leaving it as is. If `true` or omitted (default), Vapi will configure both the voice and messaging URLs. @default true

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

    This is the name of the phone number. This is just for your own reference.

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

    This is the assistant that will be used for incoming calls to this phone number. If neither ‘assistantId`, `squadId` nor `workflowId` 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.

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

    This is the workflow that will be used for incoming calls to this phone number. If neither ‘assistantId`, `squadId`, nor `workflowId` 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.

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

    This is the squad that will be used for incoming calls to this phone number. If neither ‘assistantId`, `squadId`, nor `workflowId` 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.

  • server (Vapi::Server) (defaults to: OMIT) —

    This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. The order of precedence is:

    1. assistant.server

    2. phoneNumber.server

    3. org.server

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

    These are the digits of the phone number you own on your Twilio.

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

    This is the Twilio Account SID for the phone number.

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

    This is the Twilio Auth Token for the phone number.

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

    This is the Twilio API Key for the phone number.

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

    This is the Twilio API Secret for the phone number.

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

    Additional properties unmapped to the current class definition



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
141
142
143
144
145
146
147
148
149
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 116

def initialize(fallback_destination: OMIT, hooks: OMIT, sms_enabled: OMIT, name: OMIT, assistant_id: OMIT,
               workflow_id: OMIT, squad_id: OMIT, server: OMIT, number: OMIT, twilio_account_sid: OMIT, twilio_auth_token: OMIT, twilio_api_key: OMIT, twilio_api_secret: OMIT, additional_properties: nil)
  @fallback_destination = fallback_destination if fallback_destination != OMIT
  @hooks = hooks if hooks != OMIT
  @sms_enabled = sms_enabled if sms_enabled != OMIT
  @name = name if name != OMIT
  @assistant_id = assistant_id if assistant_id != OMIT
  @workflow_id = workflow_id if workflow_id != OMIT
  @squad_id = squad_id if squad_id != OMIT
  @server = server if server != OMIT
  @number = number if number != OMIT
  @twilio_account_sid =  if  != OMIT
  @twilio_auth_token = twilio_auth_token if twilio_auth_token != OMIT
  @twilio_api_key = twilio_api_key if twilio_api_key != OMIT
  @twilio_api_secret = twilio_api_secret if twilio_api_secret != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "fallbackDestination": fallback_destination,
    "hooks": hooks,
    "smsEnabled": sms_enabled,
    "name": name,
    "assistantId": assistant_id,
    "workflowId": workflow_id,
    "squadId": squad_id,
    "server": server,
    "number": number,
    "twilioAccountSid": ,
    "twilioAuthToken": twilio_auth_token,
    "twilioApiKey": twilio_api_key,
    "twilioApiSecret": twilio_api_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.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



66
67
68
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 66

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`, `squadId` nor `workflowId` 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.

Returns:

  • (String) —

    This is the assistant that will be used for incoming calls to this phone number. If neither ‘assistantId`, `squadId` nor `workflowId` 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.



35
36
37
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 35

def assistant_id
  @assistant_id
end

#fallback_destination ⇒ Vapi::UpdateTwilioPhoneNumberDtoFallbackDestination (readonly)

Returns This is the fallback destination an inbound call will be transferred to if:

  1. ‘assistantId` is not set

  2. ‘squadId` is not set

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

Returns:

  • (Vapi::UpdateTwilioPhoneNumberDtoFallbackDestination) —

    This is the fallback destination an inbound call will be transferred to if:

    1. ‘assistantId` is not set

    2. ‘squadId` is not set

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



17
18
19
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 17

def fallback_destination
  @fallback_destination
end

#hooks ⇒ Array<Vapi::PhoneNumberHookCallRinging> (readonly)

Returns This is the hooks that will be used for incoming calls to this phone number.

Returns:



19
20
21
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 19

def hooks
  @hooks
end

#name ⇒ String (readonly)

Returns This is the name of the phone number. This is just for your own reference.

Returns:

  • (String) —

    This is the name of the phone number. This is just for your own reference.



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

def name
  @name
end

#number ⇒ String (readonly)

Returns These are the digits of the phone number you own on your Twilio.

Returns:

  • (String) —

    These are the digits of the phone number you own on your Twilio.



56
57
58
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 56

def number
  @number
end

#server ⇒ Vapi::Server (readonly)

Returns This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. The order of precedence is:

  1. assistant.server

  2. phoneNumber.server

  3. org.server.

Returns:

  • (Vapi::Server) —

    This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. The order of precedence is:

    1. assistant.server

    2. phoneNumber.server

    3. org.server



54
55
56
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 54

def server
  @server
end

#sms_enabled ⇒ Boolean (readonly)

Returns Controls whether Vapi sets the messaging webhook URL on the Twilio number during import. If set to ‘false`, Vapi will not update the Twilio messaging URL, leaving it as is. If `true` or omitted (default), Vapi will configure both the voice and messaging URLs. @default true.

Returns:

  • (Boolean) —

    Controls whether Vapi sets the messaging webhook URL on the Twilio number during import. If set to ‘false`, Vapi will not update the Twilio messaging URL, leaving it as is. If `true` or omitted (default), Vapi will configure both the voice and messaging URLs. @default true



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

def sms_enabled
  @sms_enabled
end

#squad_id ⇒ String (readonly)

Returns This is the squad that will be used for incoming calls to this phone number. If neither ‘assistantId`, `squadId`, nor `workflowId` 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.

Returns:

  • (String) —

    This is the squad that will be used for incoming calls to this phone number. If neither ‘assistantId`, `squadId`, nor `workflowId` 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.



47
48
49
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 47

def squad_id
  @squad_id
end

#twilio_account_sid ⇒ String (readonly)

Returns This is the Twilio Account SID for the phone number.

Returns:

  • (String) —

    This is the Twilio Account SID for the phone number.



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

def 
  @twilio_account_sid
end

#twilio_api_key ⇒ String (readonly)

Returns This is the Twilio API Key for the phone number.

Returns:

  • (String) —

    This is the Twilio API Key for the phone number.



62
63
64
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 62

def twilio_api_key
  @twilio_api_key
end

#twilio_api_secret ⇒ String (readonly)

Returns This is the Twilio API Secret for the phone number.

Returns:

  • (String) —

    This is the Twilio API Secret for the phone number.



64
65
66
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 64

def twilio_api_secret
  @twilio_api_secret
end

#twilio_auth_token ⇒ String (readonly)

Returns This is the Twilio Auth Token for the phone number.

Returns:

  • (String) —

    This is the Twilio Auth Token for the phone number.



60
61
62
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 60

def twilio_auth_token
  @twilio_auth_token
end

#workflow_id ⇒ String (readonly)

Returns This is the workflow that will be used for incoming calls to this phone number. If neither ‘assistantId`, `squadId`, nor `workflowId` 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.

Returns:

  • (String) —

    This is the workflow that will be used for incoming calls to this phone number. If neither ‘assistantId`, `squadId`, nor `workflowId` 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.



41
42
43
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 41

def workflow_id
  @workflow_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::UpdateTwilioPhoneNumberDto

Deserialize a JSON object to an instance of UpdateTwilioPhoneNumberDto

Parameters:

  • json_object (String)

Returns:



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 155

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::UpdateTwilioPhoneNumberDtoFallbackDestination.from_json(json_object: fallback_destination)
  end
  hooks = parsed_json["hooks"]&.map do |item|
    item = item.to_json
    Vapi::PhoneNumberHookCallRinging.from_json(json_object: item)
  end
  sms_enabled = parsed_json["smsEnabled"]
  name = parsed_json["name"]
  assistant_id = parsed_json["assistantId"]
  workflow_id = parsed_json["workflowId"]
  squad_id = parsed_json["squadId"]
  if parsed_json["server"].nil?
    server = nil
  else
    server = parsed_json["server"].to_json
    server = Vapi::Server.from_json(json_object: server)
  end
  number = parsed_json["number"]
   = parsed_json["twilioAccountSid"]
  twilio_auth_token = parsed_json["twilioAuthToken"]
  twilio_api_key = parsed_json["twilioApiKey"]
  twilio_api_secret = parsed_json["twilioApiSecret"]
  new(
    fallback_destination: fallback_destination,
    hooks: hooks,
    sms_enabled: sms_enabled,
    name: name,
    assistant_id: assistant_id,
    workflow_id: workflow_id,
    squad_id: squad_id,
    server: server,
    number: number,
    twilio_account_sid: ,
    twilio_auth_token: twilio_auth_token,
    twilio_api_key: twilio_api_key,
    twilio_api_secret: twilio_api_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.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 215

def self.validate_raw(obj:)
  obj.fallback_destination.nil? || Vapi::UpdateTwilioPhoneNumberDtoFallbackDestination.validate_raw(obj: obj.fallback_destination)
  obj.hooks&.is_a?(Array) != false || raise("Passed value for field obj.hooks is not the expected type, validation failed.")
  obj.sms_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.sms_enabled 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.workflow_id&.is_a?(String) != false || raise("Passed value for field obj.workflow_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.nil? || Vapi::Server.validate_raw(obj: obj.server)
  obj.number&.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")
  obj.&.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.twilio_api_key&.is_a?(String) != false || raise("Passed value for field obj.twilio_api_key is not the expected type, validation failed.")
  obj.twilio_api_secret&.is_a?(String) != false || raise("Passed value for field obj.twilio_api_secret is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of UpdateTwilioPhoneNumberDto to a JSON object

Returns:

  • (String) 


205
206
207
 
# File 'lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb', line 205

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