vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/twilio_credential.rb

@@ -10,6 +10,10 @@ module Vapi
     attr_reader :provider
     # @return [String] This is not returned in the API.
     attr_reader :auth_token
+    # @return [String] This is not returned in the API.
+    attr_reader :api_key
+    # @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.
@@ -32,6 +36,8 @@ module Vapi
 
     # @param provider [String]
     # @param auth_token [String] This is not returned in the API.
+    # @param api_key [String] This is not returned in the API.
+    # @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.
@@ -40,10 +46,12 @@ module Vapi
     # @param account_sid [String]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::TwilioCredential]
-    def initialize(provider:, auth_token:, id:, org_id:, created_at:, updated_at:, account_sid:, name: OMIT,
-                   additional_properties: nil)
+    def initialize(provider:, id:, org_id:, created_at:, updated_at:, account_sid:, auth_token: OMIT, api_key: OMIT,
+                   api_secret: OMIT, name: OMIT, additional_properties: nil)
       @provider = provider
-      @auth_token = auth_token
+      @auth_token = auth_token if auth_token != OMIT
+      @api_key = api_key if api_key != OMIT
+      @api_secret = api_secret if api_secret != OMIT
       @id = id
       @org_id = org_id
       @created_at = created_at
@@ -54,6 +62,8 @@ module Vapi
       @_field_set = {
         "provider": provider,
         "authToken": auth_token,
+        "apiKey": api_key,
+        "apiSecret": api_secret,
         "id": id,
         "orgId": org_id,
         "createdAt": created_at,
@@ -74,6 +84,8 @@ module Vapi
       parsed_json = JSON.parse(json_object)
       provider = parsed_json["provider"]
       auth_token = parsed_json["authToken"]
+      api_key = parsed_json["apiKey"]
+      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?)
@@ -83,6 +95,8 @@ module Vapi
       new(
         provider: provider,
         auth_token: auth_token,
+        api_key: api_key,
+        api_secret: api_secret,
         id: id,
         org_id: org_id,
         created_at: created_at,
@@ -108,7 +122,9 @@ module Vapi
     # @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.auth_token.is_a?(String) != false || raise("Passed value for field obj.auth_token is not the expected type, validation failed.")
+      obj.auth_token&.is_a?(String) != false || raise("Passed value for field obj.auth_token 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.")
+      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.")

data/lib/vapi_server_sdk/types/twilio_phone_number.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "twilio_phone_number_fallback_destination"
+require_relative "phone_number_hook_call_ringing"
 require "date"
+require_relative "twilio_phone_number_status"
 require_relative "server"
 require "ostruct"
 require "json"
@@ -15,6 +17,16 @@ module Vapi
     #  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 [Boolean] Controls whether Vapi sets the messaging webhook URL on the Twilio number during
+    #  import.
+    #  If set to `false`, Vapi will not update the Twilio messaging URL, leaving it as
+    #  is.
+    #  If `true` or omitted (default), Vapi will configure both the voice and messaging
+    #  URLs.
+    #  @default true
+    attr_reader :sms_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.
@@ -23,17 +35,33 @@ module Vapi
     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 [Vapi::TwilioPhoneNumberStatus] This is the status of the phone number.
+    attr_reader :status
+    # @return [String] This is the Twilio Auth Token for the phone number.
+    attr_reader :twilio_auth_token
+    # @return [String] This is the Twilio API Key for the phone number.
+    attr_reader :twilio_api_key
+    # @return [String] This is the Twilio API Secret for the phone number.
+    attr_reader :twilio_api_secret
     # @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.
+    #  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` 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.
+    #  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.
@@ -46,8 +74,6 @@ module Vapi
     attr_reader :number
     # @return [String] This is the Twilio Account SID for the phone number.
     attr_reader :twilio_account_sid
-    # @return [String] This is the Twilio Auth Token for the phone number.
-    attr_reader :twilio_auth_token
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -62,19 +88,38 @@ module Vapi
     #  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 sms_enabled [Boolean] Controls whether Vapi sets the messaging webhook URL on the Twilio number during
+    #  import.
+    #  If set to `false`, Vapi will not update the Twilio messaging URL, leaving it as
+    #  is.
+    #  If `true` or omitted (default), Vapi will configure both the voice and messaging
+    #  URLs.
+    #  @default true
     # @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 status [Vapi::TwilioPhoneNumberStatus] This is the status of the phone number.
+    # @param twilio_auth_token [String] This is the Twilio Auth Token for the phone number.
+    # @param twilio_api_key [String] This is the Twilio API Key for the phone number.
+    # @param twilio_api_secret [String] This is the Twilio API Secret for the phone number.
     # @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.
+    #  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` 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.
+    #  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:
@@ -83,37 +128,48 @@ module Vapi
     #  3. org.server
     # @param number [String] These are the digits of the phone number you own on your Twilio.
     # @param twilio_account_sid [String] This is the Twilio Account SID for the phone number.
-    # @param twilio_auth_token [String] This is the Twilio Auth Token for the phone number.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::TwilioPhoneNumber]
-    def initialize(id:, org_id:, created_at:, updated_at:, number:, twilio_account_sid:, twilio_auth_token:, fallback_destination: OMIT, name: OMIT, assistant_id: OMIT,
-                   squad_id: OMIT, server: OMIT, additional_properties: nil)
+    def initialize(id:, org_id:, created_at:, updated_at:, number:, twilio_account_sid:, fallback_destination: OMIT, hooks: OMIT, sms_enabled: OMIT,
+                   status: OMIT, twilio_auth_token: OMIT, twilio_api_key: OMIT, twilio_api_secret: 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
+      @sms_enabled = sms_enabled if sms_enabled != OMIT
       @id = id
       @org_id = org_id
       @created_at = created_at
       @updated_at = updated_at
+      @status = status if status != OMIT
+      @twilio_auth_token = twilio_auth_token if twilio_auth_token != OMIT
+      @twilio_api_key = twilio_api_key if twilio_api_key != OMIT
+      @twilio_api_secret = twilio_api_secret if twilio_api_secret != OMIT
       @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
       @number = number
       @twilio_account_sid = twilio_account_sid
-      @twilio_auth_token = twilio_auth_token
       @additional_properties = additional_properties
       @_field_set = {
         "fallbackDestination": fallback_destination,
+        "hooks": hooks,
+        "smsEnabled": sms_enabled,
         "id": id,
         "orgId": org_id,
         "createdAt": created_at,
         "updatedAt": updated_at,
+        "status": status,
+        "twilioAuthToken": twilio_auth_token,
+        "twilioApiKey": twilio_api_key,
+        "twilioApiSecret": twilio_api_secret,
         "name": name,
         "assistantId": assistant_id,
+        "workflowId": workflow_id,
         "squadId": squad_id,
         "server": server,
         "number": number,
-        "twilioAccountSid": twilio_account_sid,
-        "twilioAuthToken": twilio_auth_token
+        "twilioAccountSid": twilio_account_sid
       }.reject do |_k, v|
         v == OMIT
       end
@@ -132,12 +188,22 @@ module Vapi
         fallback_destination = parsed_json["fallbackDestination"].to_json
         fallback_destination = Vapi::TwilioPhoneNumberFallbackDestination.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
+      sms_enabled = parsed_json["smsEnabled"]
       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?)
+      status = parsed_json["status"]
+      twilio_auth_token = parsed_json["twilioAuthToken"]
+      twilio_api_key = parsed_json["twilioApiKey"]
+      twilio_api_secret = parsed_json["twilioApiSecret"]
       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
@@ -147,20 +213,25 @@ module Vapi
       end
       number = parsed_json["number"]
       twilio_account_sid = parsed_json["twilioAccountSid"]
-      twilio_auth_token = parsed_json["twilioAuthToken"]
       new(
         fallback_destination: fallback_destination,
+        hooks: hooks,
+        sms_enabled: sms_enabled,
         id: id,
         org_id: org_id,
         created_at: created_at,
         updated_at: updated_at,
+        status: status,
+        twilio_auth_token: twilio_auth_token,
+        twilio_api_key: twilio_api_key,
+        twilio_api_secret: twilio_api_secret,
         name: name,
         assistant_id: assistant_id,
+        workflow_id: workflow_id,
         squad_id: squad_id,
         server: server,
         number: number,
         twilio_account_sid: twilio_account_sid,
-        twilio_auth_token: twilio_auth_token,
         additional_properties: struct
       )
     end
@@ -180,17 +251,23 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.fallback_destination.nil? || Vapi::TwilioPhoneNumberFallbackDestination.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.sms_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.sms_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.status&.is_a?(Vapi::TwilioPhoneNumberStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      obj.twilio_auth_token&.is_a?(String) != false || raise("Passed value for field obj.twilio_auth_token is not the expected type, validation failed.")
+      obj.twilio_api_key&.is_a?(String) != false || raise("Passed value for field obj.twilio_api_key is not the expected type, validation failed.")
+      obj.twilio_api_secret&.is_a?(String) != false || raise("Passed value for field obj.twilio_api_secret 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)
       obj.number.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")
       obj.twilio_account_sid.is_a?(String) != false || raise("Passed value for field obj.twilio_account_sid is not the expected type, validation failed.")
-      obj.twilio_auth_token.is_a?(String) != false || raise("Passed value for field obj.twilio_auth_token is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/twilio_phone_number_status.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the status of the phone number.
+  class TwilioPhoneNumberStatus
+    ACTIVE = "active"
+    ACTIVATING = "activating"
+    BLOCKED = "blocked"
+  end
+end

data/lib/vapi_server_sdk/types/{twilio_voicemail_detection.rb → twilio_voicemail_detection_plan.rb}

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "twilio_voicemail_detection_voicemail_detection_types_item"
+require_relative "twilio_voicemail_detection_plan_voicemail_detection_types_item"
 require "ostruct"
 require "json"
 
 module Vapi
-  class TwilioVoicemailDetection
-    # @return [String] This is the provider to use for voicemail detection.
-    attr_reader :provider
-    # @return [Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>] These are the AMD messages from Twilio that are considered as voicemail. Default
+  class TwilioVoicemailDetectionPlan
+    # @return [Array<Vapi::TwilioVoicemailDetectionPlanVoicemailDetectionTypesItem>] These are the AMD messages from Twilio that are considered as voicemail. Default
     #  is ['machine_end_beep', 'machine_end_silence'].
     #  @default {Array} ['machine_end_beep', 'machine_end_silence']
     attr_reader :voicemail_detection_types
@@ -93,8 +91,7 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param provider [String] This is the provider to use for voicemail detection.
-    # @param voicemail_detection_types [Array<Vapi::TwilioVoicemailDetectionVoicemailDetectionTypesItem>] These are the AMD messages from Twilio that are considered as voicemail. Default
+    # @param voicemail_detection_types [Array<Vapi::TwilioVoicemailDetectionPlanVoicemailDetectionTypesItem>] These are the AMD messages from Twilio that are considered as voicemail. Default
     #  is ['machine_end_beep', 'machine_end_silence'].
     #  @default {Array} ['machine_end_beep', 'machine_end_silence']
     # @param enabled [Boolean] This sets whether the assistant should detect voicemail. Defaults to true.
@@ -166,10 +163,9 @@ module Vapi
     #  for more info.
     #  @default 5000
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Vapi::TwilioVoicemailDetection]
-    def initialize(provider:, voicemail_detection_types: OMIT, enabled: OMIT, machine_detection_timeout: OMIT,
+    # @return [Vapi::TwilioVoicemailDetectionPlan]
+    def initialize(voicemail_detection_types: OMIT, enabled: OMIT, machine_detection_timeout: OMIT,
                    machine_detection_speech_threshold: OMIT, machine_detection_speech_end_threshold: OMIT, machine_detection_silence_timeout: OMIT, additional_properties: nil)
-      @provider = provider
       @voicemail_detection_types = voicemail_detection_types if voicemail_detection_types != OMIT
       @enabled = enabled if enabled != OMIT
       @machine_detection_timeout = machine_detection_timeout if machine_detection_timeout != OMIT
@@ -184,7 +180,6 @@ module Vapi
       end
       @additional_properties = additional_properties
       @_field_set = {
-        "provider": provider,
         "voicemailDetectionTypes": voicemail_detection_types,
         "enabled": enabled,
         "machineDetectionTimeout": machine_detection_timeout,
@@ -196,14 +191,13 @@ module Vapi
       end
     end
 
-    # Deserialize a JSON object to an instance of TwilioVoicemailDetection
+    # Deserialize a JSON object to an instance of TwilioVoicemailDetectionPlan
     #
     # @param json_object [String]
-    # @return [Vapi::TwilioVoicemailDetection]
+    # @return [Vapi::TwilioVoicemailDetectionPlan]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      provider = parsed_json["provider"]
       voicemail_detection_types = parsed_json["voicemailDetectionTypes"]
       enabled = parsed_json["enabled"]
       machine_detection_timeout = parsed_json["machineDetectionTimeout"]
@@ -211,7 +205,6 @@ module Vapi
       machine_detection_speech_end_threshold = parsed_json["machineDetectionSpeechEndThreshold"]
       machine_detection_silence_timeout = parsed_json["machineDetectionSilenceTimeout"]
       new(
-        provider: provider,
         voicemail_detection_types: voicemail_detection_types,
         enabled: enabled,
         machine_detection_timeout: machine_detection_timeout,
@@ -222,7 +215,7 @@ module Vapi
       )
     end
 
-    # Serialize an instance of TwilioVoicemailDetection to a JSON object
+    # Serialize an instance of TwilioVoicemailDetectionPlan to a JSON object
     #
     # @return [String]
     def to_json(*_args)
@@ -236,7 +229,6 @@ module Vapi
     # @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.voicemail_detection_types&.is_a?(Array) != false || raise("Passed value for field obj.voicemail_detection_types is not the expected type, validation failed.")
       obj.enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.enabled is not the expected type, validation failed.")
       obj.machine_detection_timeout&.is_a?(Float) != false || raise("Passed value for field obj.machine_detection_timeout is not the expected type, validation failed.")

data/lib/vapi_server_sdk/types/{twilio_voicemail_detection_voicemail_detection_types_item.rb → twilio_voicemail_detection_plan_voicemail_detection_types_item.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Vapi
-  class TwilioVoicemailDetectionVoicemailDetectionTypesItem
+  class TwilioVoicemailDetectionPlanVoicemailDetectionTypesItem
     MACHINE_START = "machine_start"
     HUMAN = "human"
     FAX = "fax"