vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/byo_phone_number.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+require_relative "byo_phone_number_fallback_destination"
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ByoPhoneNumber
+    # @return [Vapi::ByoPhoneNumberFallbackDestination] 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 [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)
+    attr_reader :number_e_164_check_enabled
+    # @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] This is the number of the customer.
+    attr_reader :number
+    # @return [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.
+    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::ByoPhoneNumberFallbackDestination] 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 number_e_164_check_enabled [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)
+    # @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] This is the number of the customer.
+    # @param 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.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ByoPhoneNumber]
+    def initialize(id:, org_id:, created_at:, updated_at:, credential_id:, fallback_destination: OMIT,
+                   number_e_164_check_enabled: OMIT, name: OMIT, assistant_id: OMIT, squad_id: OMIT, server_url: OMIT, server_url_secret: OMIT, number: 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
+      @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 if number != OMIT
+      @credential_id = credential_id
+      @additional_properties = additional_properties
+      @_field_set = {
+        "fallbackDestination": fallback_destination,
+        "numberE164CheckEnabled": number_e_164_check_enabled,
+        "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 ByoPhoneNumber
+    #
+    # @param json_object [String]
+    # @return [Vapi::ByoPhoneNumber]
+    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::ByoPhoneNumberFallbackDestination.from_json(json_object: fallback_destination)
+      end
+      number_e_164_check_enabled = parsed_json["numberE164CheckEnabled"]
+      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,
+        number_e_164_check_enabled: number_e_164_check_enabled,
+        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 ByoPhoneNumber 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::ByoPhoneNumberFallbackDestination.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.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

data/lib/vapi_server_sdk/types/byo_phone_number_fallback_destination.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "transfer_destination_number"
+require_relative "transfer_destination_sip"
+
+module Vapi
+  # 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.
+  class ByoPhoneNumberFallbackDestination
+    # @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::ByoPhoneNumberFallbackDestination]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of ByoPhoneNumberFallbackDestination
+    #
+    # @param json_object [String]
+    # @return [Vapi::ByoPhoneNumberFallbackDestination]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "number"
+                 Vapi::TransferDestinationNumber.from_json(json_object: json_object)
+               when "sip"
+                 Vapi::TransferDestinationSip.from_json(json_object: json_object)
+               else
+                 Vapi::TransferDestinationNumber.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 "number"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "sip"
+        { **@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 "number"
+        Vapi::TransferDestinationNumber.validate_raw(obj: obj)
+      when "sip"
+        Vapi::TransferDestinationSip.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::TransferDestinationNumber]
+    # @return [Vapi::ByoPhoneNumberFallbackDestination]
+    def self.number(member:)
+      new(member: member, discriminant: "number")
+    end
+
+    # @param member [Vapi::TransferDestinationSip]
+    # @return [Vapi::ByoPhoneNumberFallbackDestination]
+    def self.sip(member:)
+      new(member: member, discriminant: "sip")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/byo_sip_trunk_credential.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "sip_trunk_gateway"
+require_relative "sip_trunk_outbound_authentication_plan"
+require_relative "sbc_configuration"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ByoSipTrunkCredential
+    # @return [String] This can be used to bring your own SIP trunks or to connect to a Carrier.
+    attr_reader :provider
+    # @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 [Array<Vapi::SipTrunkGateway>] This is the list of SIP trunk's gateways.
+    attr_reader :gateways
+    # @return [String] This is the name of the SIP trunk. This is just for your reference.
+    attr_reader :name
+    # @return [Vapi::SipTrunkOutboundAuthenticationPlan] This can be used to configure the outbound authentication if required by the SIP
+    #  trunk.
+    attr_reader :outbound_authentication_plan
+    # @return [Boolean] This ensures the outbound origination attempts have a leading plus. Defaults to
+    #  false to match conventional telecom behavior.
+    #  Usage:
+    #  - Vonage/Twilio requires leading plus for all outbound calls. Set this to true.
+    #  @default false
+    attr_reader :outbound_leading_plus_enabled
+    # @return [Vapi::SbcConfiguration] This is an advanced configuration for enterprise deployments. This uses the
+    #  onprem SBC to trunk into the SIP trunk's `gateways`, rather than the managed SBC
+    #  provided by Vapi.
+    attr_reader :sbc_configuration
+    # @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 [String] This can be used to bring your own SIP trunks or to connect to a Carrier.
+    # @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 gateways [Array<Vapi::SipTrunkGateway>] This is the list of SIP trunk's gateways.
+    # @param name [String] This is the name of the SIP trunk. This is just for your reference.
+    # @param outbound_authentication_plan [Vapi::SipTrunkOutboundAuthenticationPlan] This can be used to configure the outbound authentication if required by the SIP
+    #  trunk.
+    # @param outbound_leading_plus_enabled [Boolean] This ensures the outbound origination attempts have a leading plus. Defaults to
+    #  false to match conventional telecom behavior.
+    #  Usage:
+    #  - Vonage/Twilio requires leading plus for all outbound calls. Set this to true.
+    #  @default false
+    # @param sbc_configuration [Vapi::SbcConfiguration] This is an advanced configuration for enterprise deployments. This uses the
+    #  onprem SBC to trunk into the SIP trunk's `gateways`, rather than the managed SBC
+    #  provided by Vapi.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ByoSipTrunkCredential]
+    def initialize(id:, org_id:, created_at:, updated_at:, gateways:, provider: OMIT, name: OMIT,
+                   outbound_authentication_plan: OMIT, outbound_leading_plus_enabled: OMIT, sbc_configuration: OMIT, additional_properties: nil)
+      @provider = provider if provider != OMIT
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @gateways = gateways
+      @name = name if name != OMIT
+      @outbound_authentication_plan = outbound_authentication_plan if outbound_authentication_plan != OMIT
+      @outbound_leading_plus_enabled = outbound_leading_plus_enabled if outbound_leading_plus_enabled != OMIT
+      @sbc_configuration = sbc_configuration if sbc_configuration != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "provider": provider,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "gateways": gateways,
+        "name": name,
+        "outboundAuthenticationPlan": outbound_authentication_plan,
+        "outboundLeadingPlusEnabled": outbound_leading_plus_enabled,
+        "sbcConfiguration": sbc_configuration
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ByoSipTrunkCredential
+    #
+    # @param json_object [String]
+    # @return [Vapi::ByoSipTrunkCredential]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      provider = parsed_json["provider"]
+      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?)
+      gateways = parsed_json["gateways"]&.map do |item|
+        item = item.to_json
+        Vapi::SipTrunkGateway.from_json(json_object: item)
+      end
+      name = parsed_json["name"]
+      if parsed_json["outboundAuthenticationPlan"].nil?
+        outbound_authentication_plan = nil
+      else
+        outbound_authentication_plan = parsed_json["outboundAuthenticationPlan"].to_json
+        outbound_authentication_plan = Vapi::SipTrunkOutboundAuthenticationPlan.from_json(json_object: outbound_authentication_plan)
+      end
+      outbound_leading_plus_enabled = parsed_json["outboundLeadingPlusEnabled"]
+      if parsed_json["sbcConfiguration"].nil?
+        sbc_configuration = nil
+      else
+        sbc_configuration = parsed_json["sbcConfiguration"].to_json
+        sbc_configuration = Vapi::SbcConfiguration.from_json(json_object: sbc_configuration)
+      end
+      new(
+        provider: provider,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        gateways: gateways,
+        name: name,
+        outbound_authentication_plan: outbound_authentication_plan,
+        outbound_leading_plus_enabled: outbound_leading_plus_enabled,
+        sbc_configuration: sbc_configuration,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ByoSipTrunkCredential 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?(String) != false || raise("Passed value for field obj.provider 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.gateways.is_a?(Array) != false || raise("Passed value for field obj.gateways 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.outbound_authentication_plan.nil? || Vapi::SipTrunkOutboundAuthenticationPlan.validate_raw(obj: obj.outbound_authentication_plan)
+      obj.outbound_leading_plus_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.outbound_leading_plus_enabled is not the expected type, validation failed.")
+      obj.sbc_configuration.nil? || Vapi::SbcConfiguration.validate_raw(obj: obj.sbc_configuration)
+    end
+  end
+end