Class: Vapi::CreateTelnyxPhoneNumberDto

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/create_telnyx_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(number:, credential_id:, fallback_destination: OMIT, hooks: OMIT, name: OMIT, assistant_id: OMIT, workflow_id: OMIT, squad_id: OMIT, server: OMIT, additional_properties: nil) ⇒ Vapi::CreateTelnyxPhoneNumberDto

Parameters:

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

  • number (String) —

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

  • credential_id (String) —

    This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups.

  • 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

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

    Additional properties unmapped to the current class definition



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/vapi_server_sdk/types/create_telnyx_phone_number_dto.rb', line 96

def initialize(number:, credential_id:, fallback_destination: OMIT, hooks: OMIT, name: OMIT, assistant_id: OMIT,
               workflow_id: OMIT, squad_id: OMIT, server: OMIT, additional_properties: nil)
  @fallback_destination = fallback_destination if fallback_destination != OMIT
  @hooks = hooks if hooks != OMIT
  @number = number
  @credential_id = credential_id
  @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
  @additional_properties = additional_properties
  @_field_set = {
    "fallbackDestination": fallback_destination,
    "hooks": hooks,
    "number": number,
    "credentialId": credential_id,
    "name": name,
    "assistantId": assistant_id,
    "workflowId": workflow_id,
    "squadId": squad_id,
    "server": server
  }.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



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

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.



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

def assistant_id
  @assistant_id
end

#credential_id ⇒ String (readonly)

Returns This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups.

Returns:

  • (String) —

    This is the credential you added in dashboard.vapi.ai/keys. This is used to configure the number to send inbound calls to Vapi, make outbound calls and do live call updates like transfers and hangups.



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

def credential_id
  @credential_id
end

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

    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/create_telnyx_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/create_telnyx_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.



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

def name
  @name
end

#number ⇒ String (readonly)

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

Returns:

  • (String) —

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



21
22
23
 
# File 'lib/vapi_server_sdk/types/create_telnyx_phone_number_dto.rb', line 21

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



52
53
54
 
# File 'lib/vapi_server_sdk/types/create_telnyx_phone_number_dto.rb', line 52

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



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

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



39
40
41
 
# File 'lib/vapi_server_sdk/types/create_telnyx_phone_number_dto.rb', line 39

def workflow_id
  @workflow_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::CreateTelnyxPhoneNumberDto

Deserialize a JSON object to an instance of CreateTelnyxPhoneNumberDto

Parameters:

  • json_object (String)

Returns:



127
128
129
130
131
132
133
134
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_telnyx_phone_number_dto.rb', line 127

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::CreateTelnyxPhoneNumberDtoFallbackDestination.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
  number = parsed_json["number"]
  credential_id = parsed_json["credentialId"]
  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
  new(
    fallback_destination: fallback_destination,
    hooks: hooks,
    number: number,
    credential_id: credential_id,
    name: name,
    assistant_id: assistant_id,
    workflow_id: workflow_id,
    squad_id: squad_id,
    server: server,
    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_telnyx_phone_number_dto.rb', line 179

def self.validate_raw(obj:)
  obj.fallback_destination.nil? || Vapi::CreateTelnyxPhoneNumberDtoFallbackDestination.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.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.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)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of CreateTelnyxPhoneNumberDto to a JSON object

Returns:

  • (String) 


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

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