Class: Vapi::CreateByoPhoneNumberDto

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/create_byo_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(credential_id:, fallback_destination: OMIT, number_e_164_check_enabled: OMIT, number: OMIT, name: OMIT, assistant_id: OMIT, squad_id: OMIT, server_url: OMIT, server_url_secret: OMIT, additional_properties: nil) ⇒ Vapi::CreateByoPhoneNumberDto

Parameters:

  • fallback_destination (Vapi::CreateByoPhoneNumberDtoFallbackDestination) (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.

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

    This is the flag to toggle the E164 check for the ‘number` field. This is an advanced property which should be used if you know your use case requires it. Use cases:

    • ‘false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`.

    This is useful for dialing out to non-E164 numbers on your SIP trunks.

    • ‘true` (default): To allow only E164 numbers like `+14155551234`. This is

    standard for PSTN calls. If ‘false`, the `number` is still required to only contain alphanumeric characters (regex: `/^+?[a-zA-Z0-9]+$/`). @default true (E164 check is enabled)

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

    This is the number of the customer.

  • credential_id (String) —

    This is the credential of your own SIP trunk or Carrier (type ‘byo-sip-trunk`) which can be used to make calls to this phone number. You can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId.

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

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

    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.

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

    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.

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

    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.

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

    Additional properties unmapped to the current class definition



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/create_byo_phone_number_dto.rb', line 104

def initialize(credential_id:, fallback_destination: OMIT, number_e_164_check_enabled: OMIT, number: 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
  @number_e_164_check_enabled = number_e_164_check_enabled if number_e_164_check_enabled != OMIT
  @number = number if number != OMIT
  @credential_id = credential_id
  @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,
    "numberE164CheckEnabled": number_e_164_check_enabled,
    "number": number,
    "credentialId": credential_id,
    "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.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



57
58
59
 
# File 'lib/vapi_server_sdk/types/create_byo_phone_number_dto.rb', line 57

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.

Returns:

  • (String) —

    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.



40
41
42
 
# File 'lib/vapi_server_sdk/types/create_byo_phone_number_dto.rb', line 40

def assistant_id
  @assistant_id
end

#credential_id ⇒ String (readonly)

Returns This is the credential of your own SIP trunk or Carrier (type ‘byo-sip-trunk`) which can be used to make calls to this phone number. You can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId.

Returns:

  • (String) —

    This is the credential of your own SIP trunk or Carrier (type ‘byo-sip-trunk`) which can be used to make calls to this phone number. You can add the SIP trunk or Carrier credential in the Provider Credentials page on the Dashboard to get the credentialId.



33
34
35
 
# File 'lib/vapi_server_sdk/types/create_byo_phone_number_dto.rb', line 33

def credential_id
  @credential_id
end

#fallback_destination ⇒ Vapi::CreateByoPhoneNumberDtoFallbackDestination (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::CreateByoPhoneNumberDtoFallbackDestination) —

    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.



15
16
17
 
# File 'lib/vapi_server_sdk/types/create_byo_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.

Returns:

  • (String) —

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



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

def name
  @name
end

#number ⇒ String (readonly)

Returns This is the number of the customer.

Returns:

  • (String) —

    This is the number of the customer.



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

def number
  @number
end

#number_e_164_check_enabled ⇒ Boolean (readonly)

Returns This is the flag to toggle the E164 check for the ‘number` field. This is an advanced property which should be used if you know your use case requires it. Use cases:

  • ‘false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`.

This is useful for dialing out to non-E164 numbers on your SIP trunks.

  • ‘true` (default): To allow only E164 numbers like `+14155551234`. This is

standard for PSTN calls. If ‘false`, the `number` is still required to only contain alphanumeric characters (regex: `/^+?[a-zA-Z0-9]+$/`). @default true (E164 check is enabled).

Returns:

  • (Boolean) —

    This is the flag to toggle the E164 check for the ‘number` field. This is an advanced property which should be used if you know your use case requires it. Use cases:

    • ‘false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`.

    This is useful for dialing out to non-E164 numbers on your SIP trunks.

    • ‘true` (default): To allow only E164 numbers like `+14155551234`. This is

    standard for PSTN calls. If ‘false`, the `number` is still required to only contain alphanumeric characters (regex: `/^+?[a-zA-Z0-9]+$/`). @default true (E164 check is enabled)



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

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

Returns:

  • (String) —

    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.



51
52
53
 
# File 'lib/vapi_server_sdk/types/create_byo_phone_number_dto.rb', line 51

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.

Returns:

  • (String) —

    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.



55
56
57
 
# File 'lib/vapi_server_sdk/types/create_byo_phone_number_dto.rb', line 55

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.

Returns:

  • (String) —

    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.



45
46
47
 
# File 'lib/vapi_server_sdk/types/create_byo_phone_number_dto.rb', line 45

def squad_id
  @squad_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::CreateByoPhoneNumberDto

Deserialize a JSON object to an instance of CreateByoPhoneNumberDto

Parameters:

  • json_object (String)

Returns:



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/vapi_server_sdk/types/create_byo_phone_number_dto.rb', line 135

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::CreateByoPhoneNumberDtoFallbackDestination.from_json(json_object: fallback_destination)
  end
  number_e_164_check_enabled = parsed_json["numberE164CheckEnabled"]
  number = parsed_json["number"]
  credential_id = parsed_json["credentialId"]
  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,
    number_e_164_check_enabled: number_e_164_check_enabled,
    number: number,
    credential_id: credential_id,
    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.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/vapi_server_sdk/types/create_byo_phone_number_dto.rb', line 179

def self.validate_raw(obj:)
  obj.fallback_destination.nil? || Vapi::CreateByoPhoneNumberDtoFallbackDestination.validate_raw(obj: obj.fallback_destination)
  obj.number_e_164_check_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.number_e_164_check_enabled is not the expected type, validation failed.")
  obj.number&.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")
  obj.credential_id.is_a?(String) != false || raise("Passed value for field obj.credential_id 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 CreateByoPhoneNumberDto to a JSON object

Returns:

  • (String) 


169
170
171
 
# File 'lib/vapi_server_sdk/types/create_byo_phone_number_dto.rb', line 169

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