vapi_server_sdk 0.5.0 → 0.9.1

data/lib/vapi_server_sdk/types/create_slack_send_message_tool_dto_messages_item.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "tool_message_start"
+require_relative "tool_message_complete"
+require_relative "tool_message_failed"
+require_relative "tool_message_delayed"
+
+module Vapi
+  class CreateSlackSendMessageToolDtoMessagesItem
+    # @return [Object]
+    attr_reader :member
+    # @return [String]
+    attr_reader :discriminant
+
+    private_class_method :new
+    alias kind_of? is_a?
+
+    # @param member [Object]
+    # @param discriminant [String]
+    # @return [Vapi::CreateSlackSendMessageToolDtoMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  CreateSlackSendMessageToolDtoMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateSlackSendMessageToolDtoMessagesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "request-start"
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
+               when "request-complete"
+                 Vapi::ToolMessageComplete.from_json(json_object: json_object)
+               when "request-failed"
+                 Vapi::ToolMessageFailed.from_json(json_object: json_object)
+               when "request-response-delayed"
+                 Vapi::ToolMessageDelayed.from_json(json_object: json_object)
+               else
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.type)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [String]
+    def to_json(*_args)
+      case @discriminant
+      when "request-start"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-complete"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-failed"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-response-delayed"
+        { **@member.to_json, type: @discriminant }.to_json
+      else
+        { "type": @discriminant, value: @member }.to_json
+      end
+      @member.to_json
+    end
+
+    # 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.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      case obj.type
+      when "request-start"
+        Vapi::ToolMessageStart.validate_raw(obj: obj)
+      when "request-complete"
+        Vapi::ToolMessageComplete.validate_raw(obj: obj)
+      when "request-failed"
+        Vapi::ToolMessageFailed.validate_raw(obj: obj)
+      when "request-response-delayed"
+        Vapi::ToolMessageDelayed.validate_raw(obj: obj)
+      else
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+
+    # For Union Types, is_a? functionality is delegated to the wrapped member.
+    #
+    # @param obj [Object]
+    # @return [Boolean]
+    def is_a?(obj)
+      @member.is_a?(obj)
+    end
+
+    # @param member [Vapi::ToolMessageStart]
+    # @return [Vapi::CreateSlackSendMessageToolDtoMessagesItem]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
+    # @param member [Vapi::ToolMessageComplete]
+    # @return [Vapi::CreateSlackSendMessageToolDtoMessagesItem]
+    def self.request_complete(member:)
+      new(member: member, discriminant: "request-complete")
+    end
+
+    # @param member [Vapi::ToolMessageFailed]
+    # @return [Vapi::CreateSlackSendMessageToolDtoMessagesItem]
+    def self.request_failed(member:)
+      new(member: member, discriminant: "request-failed")
+    end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::CreateSlackSendMessageToolDtoMessagesItem]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_sms_tool_dto.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative "create_sms_tool_dto_messages_item"
+require_relative "open_ai_function"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateSmsToolDto
+    # @return [Array<Vapi::CreateSmsToolDtoMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
+    #  For some tools, this is auto-filled based on special fields like
+    #  `tool.destinations`. For others like the function tool, these can be custom
+    #  configured.
+    attr_reader :messages
+    # @return [Vapi::OpenAiFunction] This is the function definition of the tool.
+    #  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
+    #  tool-specific fields like `tool.destinations`. But, even in those cases, you can
+    #  provide a custom function definition for advanced use cases.
+    #  An example of an advanced use case is if you want to customize the message
+    #  that's spoken for `endCall` tool. You can specify a function where it returns an
+    #  argument "reason". Then, in `messages` array, you can have many
+    #  "request-complete" messages. One of these messages will be triggered if the
+    #  `messages[].conditions` matches the "reason" argument.
+    attr_reader :function
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param messages [Array<Vapi::CreateSmsToolDtoMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
+    #  For some tools, this is auto-filled based on special fields like
+    #  `tool.destinations`. For others like the function tool, these can be custom
+    #  configured.
+    # @param function [Vapi::OpenAiFunction] This is the function definition of the tool.
+    #  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
+    #  tool-specific fields like `tool.destinations`. But, even in those cases, you can
+    #  provide a custom function definition for advanced use cases.
+    #  An example of an advanced use case is if you want to customize the message
+    #  that's spoken for `endCall` tool. You can specify a function where it returns an
+    #  argument "reason". Then, in `messages` array, you can have many
+    #  "request-complete" messages. One of these messages will be triggered if the
+    #  `messages[].conditions` matches the "reason" argument.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateSmsToolDto]
+    def initialize(messages: OMIT, function: OMIT, additional_properties: nil)
+      @messages = messages if messages != OMIT
+      @function = function if function != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "messages": messages, "function": function }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateSmsToolDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateSmsToolDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      messages = parsed_json["messages"]&.map do |item|
+        item = item.to_json
+        Vapi::CreateSmsToolDtoMessagesItem.from_json(json_object: item)
+      end
+      if parsed_json["function"].nil?
+        function = nil
+      else
+        function = parsed_json["function"].to_json
+        function = Vapi::OpenAiFunction.from_json(json_object: function)
+      end
+      new(
+        messages: messages,
+        function: function,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateSmsToolDto to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # 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.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
+      obj.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_sms_tool_dto_messages_item.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "tool_message_start"
+require_relative "tool_message_complete"
+require_relative "tool_message_failed"
+require_relative "tool_message_delayed"
+
+module Vapi
+  class CreateSmsToolDtoMessagesItem
+    # @return [Object]
+    attr_reader :member
+    # @return [String]
+    attr_reader :discriminant
+
+    private_class_method :new
+    alias kind_of? is_a?
+
+    # @param member [Object]
+    # @param discriminant [String]
+    # @return [Vapi::CreateSmsToolDtoMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of CreateSmsToolDtoMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateSmsToolDtoMessagesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "request-start"
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
+               when "request-complete"
+                 Vapi::ToolMessageComplete.from_json(json_object: json_object)
+               when "request-failed"
+                 Vapi::ToolMessageFailed.from_json(json_object: json_object)
+               when "request-response-delayed"
+                 Vapi::ToolMessageDelayed.from_json(json_object: json_object)
+               else
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.type)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [String]
+    def to_json(*_args)
+      case @discriminant
+      when "request-start"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-complete"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-failed"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "request-response-delayed"
+        { **@member.to_json, type: @discriminant }.to_json
+      else
+        { "type": @discriminant, value: @member }.to_json
+      end
+      @member.to_json
+    end
+
+    # 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.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      case obj.type
+      when "request-start"
+        Vapi::ToolMessageStart.validate_raw(obj: obj)
+      when "request-complete"
+        Vapi::ToolMessageComplete.validate_raw(obj: obj)
+      when "request-failed"
+        Vapi::ToolMessageFailed.validate_raw(obj: obj)
+      when "request-response-delayed"
+        Vapi::ToolMessageDelayed.validate_raw(obj: obj)
+      else
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+
+    # For Union Types, is_a? functionality is delegated to the wrapped member.
+    #
+    # @param obj [Object]
+    # @return [Boolean]
+    def is_a?(obj)
+      @member.is_a?(obj)
+    end
+
+    # @param member [Vapi::ToolMessageStart]
+    # @return [Vapi::CreateSmsToolDtoMessagesItem]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
+    # @param member [Vapi::ToolMessageComplete]
+    # @return [Vapi::CreateSmsToolDtoMessagesItem]
+    def self.request_complete(member:)
+      new(member: member, discriminant: "request-complete")
+    end
+
+    # @param member [Vapi::ToolMessageFailed]
+    # @return [Vapi::CreateSmsToolDtoMessagesItem]
+    def self.request_failed(member:)
+      new(member: member, discriminant: "request-failed")
+    end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::CreateSmsToolDtoMessagesItem]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_speechmatics_credential_dto.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateSpeechmaticsCredentialDto
+    # @return [String] This is not returned in the API.
+    attr_reader :api_key
+    # @return [String] This is the name of credential. This is just for your reference.
+    attr_reader :name
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param api_key [String] This is not returned in the API.
+    # @param name [String] This is the name of credential. This is just for your reference.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateSpeechmaticsCredentialDto]
+    def initialize(api_key:, name: OMIT, additional_properties: nil)
+      @api_key = api_key
+      @name = name if name != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "apiKey": api_key, "name": name }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateSpeechmaticsCredentialDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateSpeechmaticsCredentialDto]
+    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"]
+      new(
+        api_key: api_key,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateSpeechmaticsCredentialDto to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # 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.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_supabase_credential_dto.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative "supabase_bucket_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateSupabaseCredentialDto
+    # @return [Float] This is the order in which this storage provider is tried during upload retries.
+    #  Lower numbers are tried first in increasing order.
+    attr_reader :fallback_index
+    # @return [Vapi::SupabaseBucketPlan]
+    attr_reader :bucket_plan
+    # @return [String] This is the name of credential. This is just for your reference.
+    attr_reader :name
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param fallback_index [Float] This is the order in which this storage provider is tried during upload retries.
+    #  Lower numbers are tried first in increasing order.
+    # @param bucket_plan [Vapi::SupabaseBucketPlan]
+    # @param name [String] This is the name of credential. This is just for your reference.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateSupabaseCredentialDto]
+    def initialize(fallback_index: OMIT, bucket_plan: OMIT, name: OMIT, additional_properties: nil)
+      @fallback_index = fallback_index if fallback_index != OMIT
+      @bucket_plan = bucket_plan if bucket_plan != OMIT
+      @name = name if name != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "fallbackIndex": fallback_index, "bucketPlan": bucket_plan, "name": name }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateSupabaseCredentialDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateSupabaseCredentialDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      fallback_index = parsed_json["fallbackIndex"]
+      if parsed_json["bucketPlan"].nil?
+        bucket_plan = nil
+      else
+        bucket_plan = parsed_json["bucketPlan"].to_json
+        bucket_plan = Vapi::SupabaseBucketPlan.from_json(json_object: bucket_plan)
+      end
+      name = parsed_json["name"]
+      new(
+        fallback_index: fallback_index,
+        bucket_plan: bucket_plan,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateSupabaseCredentialDto to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # 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.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.fallback_index&.is_a?(Float) != false || raise("Passed value for field obj.fallback_index is not the expected type, validation failed.")
+      obj.bucket_plan.nil? || Vapi::SupabaseBucketPlan.validate_raw(obj: obj.bucket_plan)
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_telnyx_phone_number_dto.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+require_relative "create_telnyx_phone_number_dto_fallback_destination"
+require_relative "phone_number_hook_call_ringing"
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateTelnyxPhoneNumberDto
+    # @return [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.
+    attr_reader :fallback_destination
+    # @return [Array<Vapi::PhoneNumberHookCallRinging>] This is the hooks that will be used for incoming calls to this phone number.
+    attr_reader :hooks
+    # @return [String] These are the digits of the phone number you own on your Telnyx.
+    attr_reader :number
+    # @return [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.
+    attr_reader :credential_id
+    # @return [String] This is the name of the phone number. This is just for your own reference.
+    attr_reader :name
+    # @return [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.
+    attr_reader :assistant_id
+    # @return [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.
+    attr_reader :workflow_id
+    # @return [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.
+    attr_reader :squad_id
+    # @return [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
+    attr_reader :server
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param fallback_destination [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.
+    # @param hooks [Array<Vapi::PhoneNumberHookCallRinging>] This is the hooks that will be used for incoming calls to this phone number.
+    # @param number [String] These are the digits of the phone number you own on your Telnyx.
+    # @param 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.
+    # @param name [String] This is the name of the phone number. This is just for your own reference.
+    # @param assistant_id [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.
+    # @param workflow_id [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.
+    # @param squad_id [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.
+    # @param server [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
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateTelnyxPhoneNumberDto]
+    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
+
+    # Deserialize a JSON object to an instance of CreateTelnyxPhoneNumberDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateTelnyxPhoneNumberDto]
+    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
+
+    # Serialize an instance of CreateTelnyxPhoneNumberDto to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # 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.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    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
+  end
+end