vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/voice_library.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+require_relative "voice_library_gender"
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class VoiceLibrary
+    # @return [Hash{String => Object}] This is the voice provider that will be used.
+    attr_reader :provider
+    # @return [String] The ID of the voice provided by the provider.
+    attr_reader :provider_id
+    # @return [String] The unique slug of the voice.
+    attr_reader :slug
+    # @return [String] The name of the voice.
+    attr_reader :name
+    # @return [String] The language of the voice.
+    attr_reader :language
+    # @return [String] The language code of the voice.
+    attr_reader :language_code
+    # @return [String] The model of the voice.
+    attr_reader :model
+    # @return [String] The supported models of the voice.
+    attr_reader :supported_models
+    # @return [Vapi::VoiceLibraryGender] The gender of the voice.
+    attr_reader :gender
+    # @return [String] The accent of the voice.
+    attr_reader :accent
+    # @return [String] The preview URL of the voice.
+    attr_reader :preview_url
+    # @return [String] The description of the voice.
+    attr_reader :description
+    # @return [String] The credential ID of the voice.
+    attr_reader :credential_id
+    # @return [String] The unique identifier for the voice library.
+    attr_reader :id
+    # @return [String] The unique identifier for the organization that this voice library belongs to.
+    attr_reader :org_id
+    # @return [Boolean] The Public voice is shared accross all the organizations.
+    attr_reader :is_public
+    # @return [Boolean] The deletion status of the voice.
+    attr_reader :is_deleted
+    # @return [DateTime] The ISO 8601 date-time string of when the voice library was created.
+    attr_reader :created_at
+    # @return [DateTime] The ISO 8601 date-time string of when the voice library was last updated.
+    attr_reader :updated_at
+    # @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 provider [Hash{String => Object}] This is the voice provider that will be used.
+    # @param provider_id [String] The ID of the voice provided by the provider.
+    # @param slug [String] The unique slug of the voice.
+    # @param name [String] The name of the voice.
+    # @param language [String] The language of the voice.
+    # @param language_code [String] The language code of the voice.
+    # @param model [String] The model of the voice.
+    # @param supported_models [String] The supported models of the voice.
+    # @param gender [Vapi::VoiceLibraryGender] The gender of the voice.
+    # @param accent [String] The accent of the voice.
+    # @param preview_url [String] The preview URL of the voice.
+    # @param description [String] The description of the voice.
+    # @param credential_id [String] The credential ID of the voice.
+    # @param id [String] The unique identifier for the voice library.
+    # @param org_id [String] The unique identifier for the organization that this voice library belongs to.
+    # @param is_public [Boolean] The Public voice is shared accross all the organizations.
+    # @param is_deleted [Boolean] The deletion status of the voice.
+    # @param created_at [DateTime] The ISO 8601 date-time string of when the voice library was created.
+    # @param updated_at [DateTime] The ISO 8601 date-time string of when the voice library was last updated.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::VoiceLibrary]
+    def initialize(id:, org_id:, is_public:, is_deleted:, created_at:, updated_at:, provider: OMIT, provider_id: OMIT, slug: OMIT, name: OMIT, language: OMIT, language_code: OMIT,
+                   model: OMIT, supported_models: OMIT, gender: OMIT, accent: OMIT, preview_url: OMIT, description: OMIT, credential_id: OMIT, additional_properties: nil)
+      @provider = provider if provider != OMIT
+      @provider_id = provider_id if provider_id != OMIT
+      @slug = slug if slug != OMIT
+      @name = name if name != OMIT
+      @language = language if language != OMIT
+      @language_code = language_code if language_code != OMIT
+      @model = model if model != OMIT
+      @supported_models = supported_models if supported_models != OMIT
+      @gender = gender if gender != OMIT
+      @accent = accent if accent != OMIT
+      @preview_url = preview_url if preview_url != OMIT
+      @description = description if description != OMIT
+      @credential_id = credential_id if credential_id != OMIT
+      @id = id
+      @org_id = org_id
+      @is_public = is_public
+      @is_deleted = is_deleted
+      @created_at = created_at
+      @updated_at = updated_at
+      @additional_properties = additional_properties
+      @_field_set = {
+        "provider": provider,
+        "providerId": provider_id,
+        "slug": slug,
+        "name": name,
+        "language": language,
+        "languageCode": language_code,
+        "model": model,
+        "supportedModels": supported_models,
+        "gender": gender,
+        "accent": accent,
+        "previewUrl": preview_url,
+        "description": description,
+        "credentialId": credential_id,
+        "id": id,
+        "orgId": org_id,
+        "isPublic": is_public,
+        "isDeleted": is_deleted,
+        "createdAt": created_at,
+        "updatedAt": updated_at
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of VoiceLibrary
+    #
+    # @param json_object [String]
+    # @return [Vapi::VoiceLibrary]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      provider = parsed_json["provider"]
+      provider_id = parsed_json["providerId"]
+      slug = parsed_json["slug"]
+      name = parsed_json["name"]
+      language = parsed_json["language"]
+      language_code = parsed_json["languageCode"]
+      model = parsed_json["model"]
+      supported_models = parsed_json["supportedModels"]
+      gender = parsed_json["gender"]
+      accent = parsed_json["accent"]
+      preview_url = parsed_json["previewUrl"]
+      description = parsed_json["description"]
+      credential_id = parsed_json["credentialId"]
+      id = parsed_json["id"]
+      org_id = parsed_json["orgId"]
+      is_public = parsed_json["isPublic"]
+      is_deleted = parsed_json["isDeleted"]
+      created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
+      updated_at = (DateTime.parse(parsed_json["updatedAt"]) unless parsed_json["updatedAt"].nil?)
+      new(
+        provider: provider,
+        provider_id: provider_id,
+        slug: slug,
+        name: name,
+        language: language,
+        language_code: language_code,
+        model: model,
+        supported_models: supported_models,
+        gender: gender,
+        accent: accent,
+        preview_url: preview_url,
+        description: description,
+        credential_id: credential_id,
+        id: id,
+        org_id: org_id,
+        is_public: is_public,
+        is_deleted: is_deleted,
+        created_at: created_at,
+        updated_at: updated_at,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of VoiceLibrary 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.provider&.is_a?(Hash) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
+      obj.provider_id&.is_a?(String) != false || raise("Passed value for field obj.provider_id is not the expected type, validation failed.")
+      obj.slug&.is_a?(String) != false || raise("Passed value for field obj.slug 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.language&.is_a?(String) != false || raise("Passed value for field obj.language is not the expected type, validation failed.")
+      obj.language_code&.is_a?(String) != false || raise("Passed value for field obj.language_code is not the expected type, validation failed.")
+      obj.model&.is_a?(String) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.supported_models&.is_a?(String) != false || raise("Passed value for field obj.supported_models is not the expected type, validation failed.")
+      obj.gender&.is_a?(Vapi::VoiceLibraryGender) != false || raise("Passed value for field obj.gender is not the expected type, validation failed.")
+      obj.accent&.is_a?(String) != false || raise("Passed value for field obj.accent is not the expected type, validation failed.")
+      obj.preview_url&.is_a?(String) != false || raise("Passed value for field obj.preview_url is not the expected type, validation failed.")
+      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description 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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
+      obj.is_public.is_a?(Boolean) != false || raise("Passed value for field obj.is_public is not the expected type, validation failed.")
+      obj.is_deleted.is_a?(Boolean) != false || raise("Passed value for field obj.is_deleted is not the expected type, validation failed.")
+      obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+      obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/voice_library_gender.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # The gender of the voice.
+  class VoiceLibraryGender
+    MALE = "male"
+    FEMALE = "female"
+  end
+end

data/lib/vapi_server_sdk/types/voice_library_voice_response.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class VoiceLibraryVoiceResponse
+    # @return [String]
+    attr_reader :voice_id
+    # @return [String]
+    attr_reader :name
+    # @return [String]
+    attr_reader :public_owner_id
+    # @return [String]
+    attr_reader :description
+    # @return [String]
+    attr_reader :gender
+    # @return [Hash{String => Object}]
+    attr_reader :age
+    # @return [String]
+    attr_reader :accent
+    # @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 voice_id [String]
+    # @param name [String]
+    # @param public_owner_id [String]
+    # @param description [String]
+    # @param gender [String]
+    # @param age [Hash{String => Object}]
+    # @param accent [String]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::VoiceLibraryVoiceResponse]
+    def initialize(voice_id:, name:, public_owner_id: OMIT, description: OMIT, gender: OMIT, age: OMIT, accent: OMIT,
+                   additional_properties: nil)
+      @voice_id = voice_id
+      @name = name
+      @public_owner_id = public_owner_id if public_owner_id != OMIT
+      @description = description if description != OMIT
+      @gender = gender if gender != OMIT
+      @age = age if age != OMIT
+      @accent = accent if accent != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "voiceId": voice_id,
+        "name": name,
+        "publicOwnerId": public_owner_id,
+        "description": description,
+        "gender": gender,
+        "age": age,
+        "accent": accent
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of VoiceLibraryVoiceResponse
+    #
+    # @param json_object [String]
+    # @return [Vapi::VoiceLibraryVoiceResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      voice_id = parsed_json["voiceId"]
+      name = parsed_json["name"]
+      public_owner_id = parsed_json["publicOwnerId"]
+      description = parsed_json["description"]
+      gender = parsed_json["gender"]
+      age = parsed_json["age"]
+      accent = parsed_json["accent"]
+      new(
+        voice_id: voice_id,
+        name: name,
+        public_owner_id: public_owner_id,
+        description: description,
+        gender: gender,
+        age: age,
+        accent: accent,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of VoiceLibraryVoiceResponse 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.voice_id.is_a?(String) != false || raise("Passed value for field obj.voice_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.public_owner_id&.is_a?(String) != false || raise("Passed value for field obj.public_owner_id is not the expected type, validation failed.")
+      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+      obj.gender&.is_a?(String) != false || raise("Passed value for field obj.gender is not the expected type, validation failed.")
+      obj.age&.is_a?(Hash) != false || raise("Passed value for field obj.age is not the expected type, validation failed.")
+      obj.accent&.is_a?(String) != false || raise("Passed value for field obj.accent is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/vonage_credential.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class VonageCredential
+    # @return [String] This is not returned in the API.
+    attr_reader :vonage_application_private_key
+    # @return [String]
+    attr_reader :provider
+    # @return [String] This is not returned in the API.
+    attr_reader :api_secret
+    # @return [String] This is the unique identifier for the credential.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the org that this credential belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the credential was created.
+    attr_reader :created_at
+    # @return [DateTime] This is the ISO 8601 date-time string of when the assistant was last updated.
+    attr_reader :updated_at
+    # @return [String] This is the Vonage Application ID for the credential.
+    #  Only relevant for Vonage credentials.
+    attr_reader :vonage_application_id
+    # @return [String]
+    attr_reader :api_key
+    # @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 vonage_application_private_key [String] This is not returned in the API.
+    # @param provider [String]
+    # @param api_secret [String] This is not returned in the API.
+    # @param id [String] This is the unique identifier for the credential.
+    # @param org_id [String] This is the unique identifier for the org that this credential belongs to.
+    # @param created_at [DateTime] This is the ISO 8601 date-time string of when the credential was created.
+    # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the assistant was last updated.
+    # @param vonage_application_id [String] This is the Vonage Application ID for the credential.
+    #  Only relevant for Vonage credentials.
+    # @param api_key [String]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::VonageCredential]
+    def initialize(vonage_application_private_key:, provider:, api_secret:, id:, org_id:, created_at:, updated_at:,
+                   vonage_application_id:, api_key:, additional_properties: nil)
+      @vonage_application_private_key = vonage_application_private_key
+      @provider = provider
+      @api_secret = api_secret
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @vonage_application_id = vonage_application_id
+      @api_key = api_key
+      @additional_properties = additional_properties
+      @_field_set = {
+        "vonageApplicationPrivateKey": vonage_application_private_key,
+        "provider": provider,
+        "apiSecret": api_secret,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "vonageApplicationId": vonage_application_id,
+        "apiKey": api_key
+      }
+    end
+
+    # Deserialize a JSON object to an instance of VonageCredential
+    #
+    # @param json_object [String]
+    # @return [Vapi::VonageCredential]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      vonage_application_private_key = parsed_json["vonageApplicationPrivateKey"]
+      provider = parsed_json["provider"]
+      api_secret = parsed_json["apiSecret"]
+      id = parsed_json["id"]
+      org_id = parsed_json["orgId"]
+      created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
+      updated_at = (DateTime.parse(parsed_json["updatedAt"]) unless parsed_json["updatedAt"].nil?)
+      vonage_application_id = parsed_json["vonageApplicationId"]
+      api_key = parsed_json["apiKey"]
+      new(
+        vonage_application_private_key: vonage_application_private_key,
+        provider: provider,
+        api_secret: api_secret,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        vonage_application_id: vonage_application_id,
+        api_key: api_key,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of VonageCredential 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.vonage_application_private_key.is_a?(String) != false || raise("Passed value for field obj.vonage_application_private_key is not the expected type, validation failed.")
+      obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
+      obj.api_secret.is_a?(String) != false || raise("Passed value for field obj.api_secret is not the expected type, validation failed.")
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
+      obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+      obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
+      obj.vonage_application_id.is_a?(String) != false || raise("Passed value for field obj.vonage_application_id is not the expected type, validation failed.")
+      obj.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/vonage_phone_number.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require_relative "vonage_phone_number_fallback_destination"
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class VonagePhoneNumber
+    # @return [Vapi::VonagePhoneNumberFallbackDestination] 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 [String] This is the unique identifier for the phone number.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the org that this phone number belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the phone number was created.
+    attr_reader :created_at
+    # @return [DateTime] This is the ISO 8601 date-time string of when the phone number was last updated.
+    attr_reader :updated_at
+    # @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` 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.
+    attr_reader :assistant_id
+    # @return [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.
+    attr_reader :squad_id
+    # @return [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.
+    attr_reader :server_url
+    # @return [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.
+    attr_reader :server_url_secret
+    # @return [String] These are the digits of the phone number you own on your Vonage.
+    attr_reader :number
+    # @return [String] This is the credential that is used to make outgoing calls, and do operations
+    #  like call transfer and hang up.
+    attr_reader :credential_id
+    # @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::VonagePhoneNumberFallbackDestination] 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 id [String] This is the unique identifier for the phone number.
+    # @param org_id [String] This is the unique identifier for the org that this phone number belongs to.
+    # @param created_at [DateTime] This is the ISO 8601 date-time string of when the phone number was created.
+    # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the phone number was last updated.
+    # @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` 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.
+    # @param squad_id [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.
+    # @param server_url [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.
+    # @param server_url_secret [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.
+    # @param number [String] These are the digits of the phone number you own on your Vonage.
+    # @param credential_id [String] This is the credential that is used to make outgoing calls, and do operations
+    #  like call transfer and hang up.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::VonagePhoneNumber]
+    def initialize(id:, org_id:, created_at:, updated_at:, number:, credential_id:, 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
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @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
+      @number = number
+      @credential_id = credential_id
+      @additional_properties = additional_properties
+      @_field_set = {
+        "fallbackDestination": fallback_destination,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "name": name,
+        "assistantId": assistant_id,
+        "squadId": squad_id,
+        "serverUrl": server_url,
+        "serverUrlSecret": server_url_secret,
+        "number": number,
+        "credentialId": credential_id
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of VonagePhoneNumber
+    #
+    # @param json_object [String]
+    # @return [Vapi::VonagePhoneNumber]
+    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::VonagePhoneNumberFallbackDestination.from_json(json_object: fallback_destination)
+      end
+      id = parsed_json["id"]
+      org_id = parsed_json["orgId"]
+      created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
+      updated_at = (DateTime.parse(parsed_json["updatedAt"]) unless parsed_json["updatedAt"].nil?)
+      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"]
+      number = parsed_json["number"]
+      credential_id = parsed_json["credentialId"]
+      new(
+        fallback_destination: fallback_destination,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        name: name,
+        assistant_id: assistant_id,
+        squad_id: squad_id,
+        server_url: server_url,
+        server_url_secret: server_url_secret,
+        number: number,
+        credential_id: credential_id,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of VonagePhoneNumber 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::VonagePhoneNumberFallbackDestination.validate_raw(obj: obj.fallback_destination)
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
+      obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+      obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at 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.")
+      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.")
+    end
+  end
+end