retell-sdk-unofficial 0.1.0

data/lib/retell/sdk/unofficial/api/phone_number.rb

@@ -0,0 +1,179 @@
+module Retell
+  module SDK
+    module Unofficial
+      module API
+        class PhoneNumber
+          def initialize(client)
+            @client = client
+          end
+
+          def create(
+            area_code: nil,
+            inbound_agent_id: nil,
+            inbound_agent: nil,
+            nickname: nil,
+            outbound_agent_id: nil,
+            outbound_agent: nil,
+            extra_headers: nil,
+            extra_query: nil,
+            extra_body: nil,
+            timeout: nil
+          )
+            inbound_agent_id = inbound_agent_id || inbound_agent
+            outbound_agent_id = outbound_agent_id || outbound_agent
+
+            inbound_agent_id = inbound_agent_id.is_a?(Retell::SDK::Unofficial::Agent) ? inbound_agent_id.agent_id : inbound_agent_id
+            outbound_agent_id = outbound_agent_id.is_a?(Retell::SDK::Unofficial::Agent) ? outbound_agent_id.agent_id : outbound_agent_id
+
+            payload = {
+              area_code: area_code,
+              inbound_agent_id: inbound_agent_id,
+              nickname: nickname,
+              outbound_agent_id: outbound_agent_id
+            }.compact
+
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.post('/create-phone-number', payload, **options)
+          end
+
+          def import(
+            phone_number,
+            termination_uri:,
+            inbound_agent_id: nil,
+            inbound_agent: nil,
+            nickname: nil,
+            outbound_agent_id: nil,
+            outbound_agent: nil,
+            sip_trunk_auth_password: nil,
+            sip_trunk_auth_username: nil,
+            extra_headers: nil,
+            extra_query: nil,
+            extra_body: nil,
+            timeout: nil
+          )
+            inbound_agent_id = inbound_agent_id || inbound_agent
+            outbound_agent_id = outbound_agent_id || outbound_agent
+
+            inbound_agent_id = inbound_agent_id.is_a?(Retell::SDK::Unofficial::Agent) ? inbound_agent_id.agent_id : inbound_agent_id
+            outbound_agent_id = outbound_agent_id.is_a?(Retell::SDK::Unofficial::Agent) ? outbound_agent_id.agent_id : outbound_agent_id
+
+            payload = {
+              phone_number: phone_number,
+              termination_uri: termination_uri,
+              inbound_agent_id: inbound_agent_id,
+              nickname: nickname,
+              outbound_agent_id: outbound_agent_id,
+              sip_trunk_auth_password: sip_trunk_auth_password,
+              sip_trunk_auth_username: sip_trunk_auth_username
+            }.compact
+
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.post('/import-phone-number', payload, **options)
+          end
+
+          def retrieve(
+            phone_number,
+            extra_headers: nil,
+            extra_query: nil,
+            extra_body: nil,
+            timeout: nil
+          )
+            phone_number = phone_number.is_a?(Retell::SDK::Unofficial::PhoneNumber) ? phone_number.phone_number : phone_number
+
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.get("/get-phone-number/#{phone_number}", **options)
+          end
+
+          def list(extra_headers: nil, extra_query: nil, extra_body: nil, timeout: nil)
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.get('/list-phone-numbers', **options)
+          end
+
+          def update(
+            phone_number,
+            inbound_agent_id: nil,
+            inbound_agent: nil,
+            nickname: nil,
+            outbound_agent_id: nil,
+            outbound_agent: nil,
+            extra_headers: nil,
+            extra_query: nil,
+            extra_body: nil,
+            timeout: nil
+          )
+            inbound_agent_id = inbound_agent_id || inbound_agent
+            outbound_agent_id = outbound_agent_id || outbound_agent
+
+            phone_number = phone_number.is_a?(Retell::SDK::Unofficial::PhoneNumber) ? phone_number.phone_number : phone_number
+            inbound_agent_id = inbound_agent_id.is_a?(Retell::SDK::Unofficial::Agent) ? inbound_agent_id.agent_id : inbound_agent_id
+            outbound_agent_id = outbound_agent_id.is_a?(Retell::SDK::Unofficial::Agent) ? outbound_agent_id.agent_id : outbound_agent_id
+
+            payload = {
+              inbound_agent_id: inbound_agent_id,
+              nickname: nickname,
+              outbound_agent_id: outbound_agent_id
+            }.compact
+
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.patch("/update-phone-number/#{phone_number}", payload, **options)
+          end
+
+          def delete(
+            phone_number,
+            extra_headers: nil,
+            extra_query: nil,
+            extra_body: nil,
+            timeout: nil
+          )
+            phone_number = phone_number.is_a?(Retell::SDK::Unofficial::PhoneNumber) ? phone_number.phone_number : phone_number
+
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.delete("/delete-phone-number/#{phone_number}", **options)
+          end
+
+          private
+
+          def validate_phone_number(value, param_name)
+            raise ArgumentError, "#{param_name} must be a valid phone number in E.164 format" unless value.match?(/^\+[1-9]\d{1,14}$/)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/retell/sdk/unofficial/api/retell_llm.rb

@@ -0,0 +1,254 @@
+module Retell
+  module SDK
+    module Unofficial
+      module API
+        class RetellLLM
+          def initialize(client)
+            @client = client
+          end
+
+          def create(
+            begin_message: nil,
+            general_prompt: nil,
+            general_tools: nil,
+            inbound_dynamic_variables_webhook_url: nil,
+            model: nil,
+            model_temperature: nil,
+            starting_state: nil,
+            states: nil,
+            extra_headers: nil,
+            extra_query: nil,
+            extra_body: nil,
+            timeout: nil
+          )
+            validate_model(model) if model
+            validate_model_temperature(model_temperature) if model_temperature
+            validate_general_tools(general_tools) if general_tools
+            validate_states(states) if states
+
+            payload = {
+              begin_message: begin_message,
+              general_prompt: general_prompt,
+              general_tools: general_tools,
+              inbound_dynamic_variables_webhook_url: inbound_dynamic_variables_webhook_url,
+              model: model,
+              model_temperature: model_temperature,
+              starting_state: starting_state,
+              states: states
+            }.compact
+
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.post('/create-retell-llm', payload, **options)
+          end
+
+          def retrieve(
+            llm_or_id,
+            extra_headers: nil,
+            extra_query: nil,
+            extra_body: nil,
+            timeout: nil
+          )
+            llm_id = llm_or_id.is_a?(Retell::SDK::Unofficial::RetellLLM) ? llm_or_id.llm_id : llm_or_id
+            validate_non_empty_string(llm_id, 'llm_id')
+
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.get("/get-retell-llm/#{llm_id}", **options)
+          end
+
+          def update(
+            llm_or_id,
+            begin_message: nil,
+            general_prompt: nil,
+            general_tools: nil,
+            inbound_dynamic_variables_webhook_url: nil,
+            model: nil,
+            model_temperature: nil,
+            starting_state: nil,
+            states: nil,
+            extra_headers: nil,
+            extra_query: nil,
+            extra_body: nil,
+            timeout: nil
+          )
+            llm_id = llm_or_id.is_a?(Retell::SDK::Unofficial::RetellLLM) ? llm_or_id.llm_id : llm_or_id
+            validate_non_empty_string(llm_id, 'llm_id')
+
+            validate_model(model) if model
+            validate_model_temperature(model_temperature) if model_temperature
+            validate_general_tools(general_tools) if general_tools
+            validate_states(states) if states
+
+            payload = {
+              begin_message: begin_message,
+              general_prompt: general_prompt,
+              general_tools: general_tools,
+              inbound_dynamic_variables_webhook_url: inbound_dynamic_variables_webhook_url,
+              model: model,
+              model_temperature: model_temperature,
+              starting_state: starting_state,
+              states: states
+            }.compact
+
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.patch("/update-retell-llm/#{llm_id}", payload, **options)
+          end
+
+          def list(
+            extra_headers: nil,
+            extra_query: nil,
+            extra_body: nil,
+            timeout: nil
+          )
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.get('/list-retell-llms', **options)
+          end
+
+          def delete(
+            llm_or_id,
+            extra_headers: nil,
+            extra_query: nil,
+            extra_body: nil,
+            timeout: nil
+          )
+            llm_id = llm_or_id.is_a?(Retell::SDK::Unofficial::RetellLLM) ? llm_or_id.llm_id : llm_or_id
+            validate_non_empty_string(llm_id, 'llm_id')
+
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.delete("/delete-retell-llm/#{llm_id}", **options)
+            nil
+          end
+
+          private
+
+          def validate_model(model)
+            valid_models = ['gpt-4o', 'gpt-4o-mini', 'claude-3.5-sonnet', 'claude-3-haiku']
+            unless valid_models.include?(model)
+              raise ArgumentError, "Invalid model: #{model}. Valid models are: #{valid_models.join(', ')}"
+            end
+          end
+
+          def validate_model_temperature(model_temperature)
+            unless model_temperature >= 0 && model_temperature <= 1
+              raise ArgumentError, "Invalid model temperature: #{model_temperature}. Model temperature must be a between 0 and 1"
+            end
+          end
+
+          def validate_general_tools(tools)
+            tools.each { |tool| validate_general_tool(tool) }
+          end
+
+          def validate_states(states)
+            states.each do |state|
+              unless state.is_a?(Hash) && state.key?(:name)
+                raise ArgumentError, "Invalid state: each state must be a hash with a 'name' key"
+              end
+              validate_state(state)
+            end
+          end
+
+          def validate_general_tool(tool)
+            case tool[:type]
+            when 'end_call', 'press_digit'
+              validate_tool_keys(tool, required: [:name, :type], optional: [:description])
+            when 'transfer_call'
+              validate_tool_keys(tool, required: [:name, :number, :type], optional: [:description])
+            when 'check_availability_cal', 'book_appointment_cal'
+              validate_tool_keys(tool, required: [:cal_api_key, :event_type_id, :name, :type], optional: [:description, :timezone])
+            when 'custom'
+              validate_custom_tool(tool)
+            else
+              raise ArgumentError, "Unknown general tool type: #{tool[:type]}"
+            end
+          end
+
+          def validate_custom_tool(tool)
+            validate_tool_keys(tool,
+              required: [:name, :type, :description, :url, :speak_after_execution, :speak_during_execution],
+              optional: [:execution_message_description, :timeout_ms, :parameters]
+            )
+            validate_custom_tool_parameters(tool[:parameters]) if tool[:parameters]
+            validate_timeout_ms(tool[:timeout_ms]) if tool[:timeout_ms]
+          end
+
+          def validate_timeout_ms(timeout_ms)
+            unless timeout_ms.is_a?(Integer) && timeout_ms >= 1000 && timeout_ms <= 600000
+              raise ArgumentError, "timeout_ms must be an integer between 1000 and 600000"
+            end
+          end
+
+          def validate_custom_tool_parameters(parameters)
+            validate_tool_keys(parameters, required: [:type, :properties], optional: [:required])
+          end
+
+          def validate_state(state)
+            validate_tool_keys(state, required: [:name], optional: [:edges, :state_prompt, :tools])
+            validate_general_tools(state[:tools]) if state[:tools]
+            validate_state_edges(state[:edges]) if state[:edges]
+          end
+
+          def validate_state_edges(edges)
+            edges.each { |edge| validate_state_edge(edge) }
+          end
+
+          def validate_state_edge(edge)
+            validate_tool_keys(edge,
+              required: [:description, :destination_state_name],
+              optional: [:parameters]
+            )
+            validate_state_edge_parameters(edge[:parameters]) if edge[:parameters]
+          end
+
+          def validate_state_edge_parameters(parameters)
+            validate_tool_keys(parameters, required: [:type, :properties], optional: [:required])
+          end
+
+          def validate_tool_keys(hash, required: [], optional: [])
+            missing_keys = required - hash.keys
+            if missing_keys.any?
+              raise ArgumentError, "Missing required keys: #{missing_keys.join(', ')}"
+            end
+
+            unexpected_keys = hash.keys - (required + optional)
+            if unexpected_keys.any?
+              raise ArgumentError, "Unexpected keys found: #{unexpected_keys.join(', ')}"
+            end
+          end
+
+          def validate_non_empty_string(value, name)
+            raise ArgumentError, "#{name} cannot be empty" if value.empty?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/retell/sdk/unofficial/api/voice.rb

@@ -0,0 +1,50 @@
+module Retell
+  module SDK
+    module Unofficial
+      module API
+        class Voice
+          def initialize(client)
+            @client = client
+          end
+
+          def retrieve(
+            voice_or_id,
+            extra_headers: nil,
+            extra_query: nil,
+            extra_body: nil,
+            timeout: nil
+          )
+            voice_id = voice_or_id.is_a?(Retell::SDK::Unofficial::Voice) ? voice_or_id.voice_id : voice_or_id
+
+            raise ArgumentError, "Expected a non-empty value for `voice_id` but received #{voice_id.inspect}" if voice_id.to_s.empty?
+
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.get("/get-voice/#{voice_id}", **options)
+          end
+
+          def list(
+            extra_headers: nil,
+            extra_query: nil,
+            extra_body: nil,
+            timeout: nil
+          )
+            options = @client.make_request_options(
+              extra_headers: extra_headers,
+              extra_query: extra_query,
+              extra_body: extra_body,
+              timeout: timeout
+            )
+
+            @client.get('/list-voices', **options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/retell/sdk/unofficial/base.rb

@@ -0,0 +1,81 @@
+module Retell
+  module SDK
+    module Unofficial
+      class Base
+        class << self
+          attr_reader :attributes
+        end
+
+        attr_accessor :client
+
+        def self.inherited(subclass)
+          subclass.instance_variable_set(:@attributes, [])
+        end
+
+        def self.each_attribute
+          @attributes.each { |attr| yield attr }
+        end
+
+        attr_reader :changed_attributes
+
+        def self.writeable_attributes
+          @writeable_attributes ||= []
+        end
+
+        def initialize(client, raw_response)
+          @client = client
+          @changed_attributes = {}
+          self.class.attributes.each do |attr|
+            instance_variable_set("@#{attr}", raw_response[attr])
+          end
+        end
+
+        def [](key)
+          send(key) if self.class.attributes.include?(key.to_sym)
+        end
+
+        def []=(key, value)
+          if self.class.writeable_attributes.include?(key.to_sym)
+            instance_variable_set("@#{key}", value)
+            @changed_attributes[key.to_sym] = value
+          else
+            raise KeyError, "key not found or not writable: #{key}"
+          end
+        end
+
+        def to_h
+          self.class.attributes.each_with_object({}) do |attr, hash|
+            hash[attr] = send(attr)
+          end
+        end
+
+        def keys
+          self.class.attributes
+        end
+
+        def values
+          self.class.attributes.map { |attr| send(attr) }
+        end
+
+        def each
+          if block_given?
+            to_h.each do |key, value|
+              yield(key, value)
+            end
+            to_h
+          else
+            to_enum(:each)
+          end
+        end
+
+        def fetch(key, default = nil)
+          if self.class.attributes.include?(key.to_sym)
+            send(key)
+          else
+            block_given? ? yield(key) : (default || raise(KeyError, "key not found: #{key}"))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/retell/sdk/unofficial/base_call.rb

@@ -0,0 +1,40 @@
+require_relative 'base'
+
+module Retell
+  module SDK
+    module Unofficial
+      class BaseCall < Base
+        @attributes = [
+          :call_id, :agent_id, :call_status, :call_type,
+          :start_timestamp, :end_timestamp, :transcript, :recording_url,
+          :public_log_url, :call_analysis, :e2e_latency, :llm_latency,
+          :llm_websocket_network_rtt_latency, :transcript_object,
+          :transcript_with_tool_calls, :disconnection_reason, :metadata,
+          :retell_llm_dynamic_variables, :opt_out_sensitive_data_storage
+        ]
+
+        attr_reader *@attributes
+
+        def id
+          call_id
+        end
+
+        def agent
+          agent_id
+        end
+
+        def status
+          call_status
+        end
+
+        def type
+          call_type
+        end
+
+        def analysis
+          call_analysis
+        end
+      end
+    end
+  end
+end

data/lib/retell/sdk/unofficial/base_list.rb

@@ -0,0 +1,52 @@
+module Retell
+  module SDK
+    module Unofficial
+      class BaseList
+        include Enumerable
+
+        attr_reader :items
+
+        def initialize(items_key, raw_response)
+          @items = raw_response[items_key]
+        end
+
+        def [](index)
+          @items[index]
+        end
+
+        def each
+          if block_given?
+            to_a.each do |value|
+              yield(value)
+            end
+            to_a
+          else
+            to_enum(:each)
+          end
+        end
+
+        def length
+          @items.length
+        end
+
+        alias_method :size, :length
+
+        def to_a
+          @items
+        end
+
+        def empty?
+          @items.empty?
+        end
+
+        def first
+          @items.first
+        end
+
+        def last
+          @items.last
+        end
+      end
+    end
+  end
+end

data/lib/retell/sdk/unofficial/call.rb

@@ -0,0 +1,18 @@
+module Retell
+  module SDK
+    module Unofficial
+      class Call
+        def self.new(client, raw_response)
+          case raw_response[:call_type]
+          when 'web_call'
+            Retell::SDK::Unofficial::WebCall.new(client, raw_response)
+          when 'phone_call'
+            Retell::SDK::Unofficial::PhoneCall.new(client, raw_response)
+          else
+            raise ArgumentError, "Unknown call type: #{raw_response[:call_type]}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/retell/sdk/unofficial/call_list.rb

@@ -0,0 +1,14 @@
+module Retell
+  module SDK
+    module Unofficial
+      class CallList < BaseList
+        attr_reader :pagination_key
+
+    def initialize(raw_response)
+      super(:calls, raw_response)
+          @pagination_key = raw_response[:pagination_key]
+        end
+      end
+    end
+  end
+end