livekit-server-sdk 0.9.0 → 1.0.0

data/lib/livekit/sip_service_client.rb

@@ -1,6 +1,8 @@
 require "livekit/proto/livekit_sip_twirp"
 require "livekit/auth_mixin"
 require 'livekit/utils'
+require 'livekit/failover'
+require 'livekit/dial_timeout'
 
 module LiveKit
   class SIPServiceClient < Twirp::Client
@@ -8,10 +10,11 @@ module LiveKit
     include AuthMixin
     attr_accessor :api_key, :api_secret
 
-    def initialize(base_url, api_key: nil, api_secret: nil)
-      super(File.join(Utils.to_http_url(base_url), "/twirp"))
+    def initialize(base_url, api_key: nil, api_secret: nil, token: nil, failover: true, connection: nil)
+      super(connection || LiveKit::Failover.connection(base_url, failover))
       @api_key = api_key
       @api_secret = api_secret
+      @token = token
     end
 
     def create_sip_inbound_trunk(
@@ -52,7 +55,7 @@ module LiveKit
           krisp_enabled: krisp_enabled
         )
       )
-      self.rpc(
+      rpc!(
         :CreateSIPInboundTrunk,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -91,7 +94,7 @@ module LiveKit
           headers_to_attributes: headers_to_attributes
         )
       )
-      self.rpc(
+      rpc!(
         :CreateSIPOutboundTrunk,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -100,7 +103,7 @@ module LiveKit
 
     def list_sip_inbound_trunk
       request = Proto::ListSIPInboundTrunkRequest.new
-      self.rpc(
+      rpc!(
         :ListSIPInboundTrunk,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -109,7 +112,7 @@ module LiveKit
 
     def list_sip_outbound_trunk
       request = Proto::ListSIPOutboundTrunkRequest.new
-      self.rpc(
+      rpc!(
         :ListSIPOutboundTrunk,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -120,7 +123,7 @@ module LiveKit
       request = Proto::DeleteSIPTrunkRequest.new(
         sip_trunk_id: sip_trunk_id,
       )
-      self.rpc(
+      rpc!(
         :DeleteSIPTrunk,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -147,7 +150,7 @@ module LiveKit
         attributes: attributes,
         room_config: room_config,
       )
-      self.rpc(
+      rpc!(
         :CreateSIPDispatchRule,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -156,7 +159,7 @@ module LiveKit
 
     def list_sip_dispatch_rule
       request = Proto::ListSIPDispatchRuleRequest.new
-      self.rpc(
+      rpc!(
         :ListSIPDispatchRule,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -167,7 +170,7 @@ module LiveKit
       request = Proto::DeleteSIPDispatchRuleRequest.new(
         sip_dispatch_rule_id: sip_dispatch_rule_id,
       )
-      self.rpc(
+      rpc!(
         :DeleteSIPDispatchRule,
         request,
         headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
@@ -178,8 +181,13 @@ module LiveKit
       sip_trunk_id,
       sip_call_to,
       room_name,
+      # Optional inline outbound trunk configuration (SIPOutboundConfig). Use
+      # instead of a stored sip_trunk_id to configure the trunk per call.
+      trunk: nil,
       # Optional SIP From number to use. If empty, trunk number is used.
       from_number: nil,
+      # Optional custom caller ID shown to the callee. Requires provider support.
+      display_name: nil,
       # Optional identity of the participant in LiveKit room
       participant_identity: nil,
       # Optional name of the participant in LiveKit room
@@ -198,12 +206,22 @@ module LiveKit
       # Optional, max call duration in seconds
       max_call_duration: nil,
       # Optional, enable Krisp for this call
-      krisp_enabled: false
+      krisp_enabled: false,
+      # Optional, wait for the call to be answered before returning
+      wait_until_answered: false,
+      # Optional, request timeout in seconds. Defaults to a longer value when
+      # wait_until_answered is set (dialing takes time).
+      timeout: nil
     )
+      # When waiting for an answer, pin the ring window explicitly so our request
+      # timeout doesn't depend on the server's default (which could change).
+      ringing_timeout = DialTimeout::DEFAULT_RINGING_TIMEOUT if wait_until_answered && ringing_timeout.nil?
       request = Proto::CreateSIPParticipantRequest.new(
         sip_trunk_id: sip_trunk_id,
+        trunk: trunk,
         sip_call_to: sip_call_to,
         sip_number: from_number,
+        display_name: display_name,
         room_name: room_name,
         participant_identity: participant_identity,
         participant_name: participant_name,
@@ -213,32 +231,140 @@ module LiveKit
         hide_phone_number: hide_phone_number,
         ringing_timeout: ringing_timeout,
         max_call_duration: max_call_duration,
-        krisp_enabled: krisp_enabled
-      )
-      self.rpc(
-        :CreateSIPParticipant,
-        request,
-        headers: auth_header(sip_grant: SIPGrant.new(call: true)),
+        krisp_enabled: krisp_enabled,
+        wait_until_answered: wait_until_answered
       )
+      headers = auth_header(sip_grant: SIPGrant.new(call: true))
+      # When waiting for an answer, dialing takes longer than a normal request
+      # and the request must outlast ringing; otherwise honor any user timeout.
+      effective_timeout = wait_until_answered ? DialTimeout.resolve(timeout, ringing_timeout) : timeout
+      headers[Failover::TIMEOUT_HEADER] = effective_timeout.to_s if effective_timeout
+      rpc!(:CreateSIPParticipant, request, headers: headers)
     end
 
     def transfer_sip_participant(
       room_name,
       participant_identity,
       transfer_to,
-      play_dialtone: nil
+      play_dialtone: nil,
+      # Optional, max time for the transfer destination to answer, in seconds.
+      ringing_timeout: nil,
+      # Optional, request timeout in seconds. Defaults to a longer value since
+      # transferring dials a phone.
+      timeout: nil
     )
 
+      # Transferring a call dials a phone and must outlast ringing. Pin the ring
+      # window explicitly so our request timeout doesn't depend on the server default.
+      ringing_timeout ||= DialTimeout::DEFAULT_RINGING_TIMEOUT
       request = Proto::TransferSIPParticipantRequest.new(
         room_name: room_name,
         participant_identity: participant_identity,
         transfer_to: transfer_to,
         play_dialtone: play_dialtone,
+        ringing_timeout: ringing_timeout,
+      )
+      headers = auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room_name), sip_grant: SIPGrant.new(call: true))
+      headers[Failover::TIMEOUT_HEADER] = DialTimeout.resolve(timeout, ringing_timeout).to_s
+      rpc!(:TransferSIPParticipant, request, headers: headers)
+    end
+
+    # Updates an existing SIP inbound trunk, replacing it entirely.
+    #
+    # @param sip_trunk_id [String] ID of the SIP inbound trunk to update
+    # @param trunk [Proto::SIPInboundTrunkInfo] the full trunk definition to replace it with
+    def update_sip_inbound_trunk(sip_trunk_id, trunk)
+      request = Proto::UpdateSIPInboundTrunkRequest.new(
+        sip_trunk_id: sip_trunk_id,
+        replace: trunk,
+      )
+      rpc!(
+        :UpdateSIPInboundTrunk,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    # Updates specific fields of an existing SIP inbound trunk. Only the fields
+    # set in +update+ are changed.
+    #
+    # @param sip_trunk_id [String] ID of the SIP inbound trunk to update
+    # @param update [Proto::SIPInboundTrunkUpdate] the fields to update
+    def update_sip_inbound_trunk_fields(sip_trunk_id, update)
+      request = Proto::UpdateSIPInboundTrunkRequest.new(
+        sip_trunk_id: sip_trunk_id,
+        update: update,
+      )
+      rpc!(
+        :UpdateSIPInboundTrunk,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    # Updates an existing SIP outbound trunk, replacing it entirely.
+    #
+    # @param sip_trunk_id [String] ID of the SIP outbound trunk to update
+    # @param trunk [Proto::SIPOutboundTrunkInfo] the full trunk definition to replace it with
+    def update_sip_outbound_trunk(sip_trunk_id, trunk)
+      request = Proto::UpdateSIPOutboundTrunkRequest.new(
+        sip_trunk_id: sip_trunk_id,
+        replace: trunk,
       )
-      self.rpc(
-        :TransferSIPParticipant,
+      rpc!(
+        :UpdateSIPOutboundTrunk,
         request,
-        headers: auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room_name), sip_grant: SIPGrant.new(call: true)),
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    # Updates specific fields of an existing SIP outbound trunk. Only the fields
+    # set in +update+ are changed.
+    #
+    # @param sip_trunk_id [String] ID of the SIP outbound trunk to update
+    # @param update [Proto::SIPOutboundTrunkUpdate] the fields to update
+    def update_sip_outbound_trunk_fields(sip_trunk_id, update)
+      request = Proto::UpdateSIPOutboundTrunkRequest.new(
+        sip_trunk_id: sip_trunk_id,
+        update: update,
+      )
+      rpc!(
+        :UpdateSIPOutboundTrunk,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    # Updates an existing SIP dispatch rule, replacing it entirely.
+    #
+    # @param sip_dispatch_rule_id [String] ID of the SIP dispatch rule to update
+    # @param rule [Proto::SIPDispatchRuleInfo] the full dispatch rule definition to replace it with
+    def update_sip_dispatch_rule(sip_dispatch_rule_id, rule)
+      request = Proto::UpdateSIPDispatchRuleRequest.new(
+        sip_dispatch_rule_id: sip_dispatch_rule_id,
+        replace: rule,
+      )
+      rpc!(
+        :UpdateSIPDispatchRule,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    # Updates specific fields of an existing SIP dispatch rule. Only the fields
+    # set in +update+ are changed.
+    #
+    # @param sip_dispatch_rule_id [String] ID of the SIP dispatch rule to update
+    # @param update [Proto::SIPDispatchRuleUpdate] the fields to update
+    def update_sip_dispatch_rule_fields(sip_dispatch_rule_id, update)
+      request = Proto::UpdateSIPDispatchRuleRequest.new(
+        sip_dispatch_rule_id: sip_dispatch_rule_id,
+        update: update,
+      )
+      rpc!(
+        :UpdateSIPDispatchRule,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
       )
     end
   end

data/lib/livekit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LiveKit
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/lib/livekit.rb

@@ -3,6 +3,7 @@
 require "livekit/access_token"
 require "livekit/utils"
 require "livekit/grants"
+require "livekit/errors"
 require "livekit/token_verifier"
 require "livekit/version"
 
@@ -13,3 +14,5 @@ require "livekit/egress_service_client"
 require "livekit/ingress_service_client"
 require "livekit/sip_service_client"
 require "livekit/agent_dispatch_service_client"
+require "livekit/connector_service_client"
+require "livekit/livekit_api"

data/livekit_server_sdk.gemspec

@@ -11,11 +11,12 @@ Gem::Specification.new do |spec|
   spec.summary = "LiveKit Server SDK for Ruby"
   spec.homepage = "https://livekit.io"
   spec.license = "Apache-2.0"
-  spec.required_ruby_version = ">= 2.6.0"
+  # google-protobuf 4.x requires Ruby >= 3.1; Ruby 3.0 is EOL.
+  spec.required_ruby_version = ">= 3.1.0"
 
-  # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/livekit/server-sdk-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/livekit/server-sdk-ruby/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -26,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "faraday", ">= 2.0", "< 3.0"
   spec.add_dependency "google-protobuf", "~> 4.30", ">= 4.30.2"
   spec.add_dependency "jwt", ">= 2.2.3", "< 3.0"
   spec.add_dependency "twirp", "~> 1.13", ">= 1.13.1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: livekit-server-sdk
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Omri Gabay
@@ -9,8 +9,28 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-02-07 00:00:00.000000000 Z
+date: 2026-07-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +100,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/CODEOWNERS"
 - ".github/banner_dark.png"
 - ".github/banner_light.png"
+- ".github/workflows/generate-protobufs.yml"
+- ".github/workflows/test-api.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".gitmodules"
@@ -117,13 +140,24 @@ files:
 - lib/livekit/access_token.rb
 - lib/livekit/agent_dispatch_service_client.rb
 - lib/livekit/auth_mixin.rb
+- lib/livekit/connector_service_client.rb
+- lib/livekit/dial_timeout.rb
 - lib/livekit/egress_service_client.rb
+- lib/livekit/errors.rb
+- lib/livekit/failover.rb
 - lib/livekit/grants.rb
 - lib/livekit/ingress_service_client.rb
+- lib/livekit/livekit_api.rb
 - lib/livekit/proto/livekit_agent_dispatch_pb.rb
 - lib/livekit/proto/livekit_agent_dispatch_twirp.rb
 - lib/livekit/proto/livekit_agent_pb.rb
 - lib/livekit/proto/livekit_agent_twirp.rb
+- lib/livekit/proto/livekit_connector_pb.rb
+- lib/livekit/proto/livekit_connector_twilio_pb.rb
+- lib/livekit/proto/livekit_connector_twilio_twirp.rb
+- lib/livekit/proto/livekit_connector_twirp.rb
+- lib/livekit/proto/livekit_connector_whatsapp_pb.rb
+- lib/livekit/proto/livekit_connector_whatsapp_twirp.rb
 - lib/livekit/proto/livekit_egress_pb.rb
 - lib/livekit/proto/livekit_egress_twirp.rb
 - lib/livekit/proto/livekit_ingress_pb.rb
@@ -134,6 +168,8 @@ files:
 - lib/livekit/proto/livekit_models_twirp.rb
 - lib/livekit/proto/livekit_room_pb.rb
 - lib/livekit/proto/livekit_room_twirp.rb
+- lib/livekit/proto/livekit_rtc_pb.rb
+- lib/livekit/proto/livekit_rtc_twirp.rb
 - lib/livekit/proto/livekit_sip_pb.rb
 - lib/livekit/proto/livekit_sip_twirp.rb
 - lib/livekit/proto/livekit_webhook_pb.rb
@@ -149,7 +185,10 @@ files:
 homepage: https://livekit.io
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  homepage_uri: https://livekit.io
+  source_code_uri: https://github.com/livekit/server-sdk-ruby
+  changelog_uri: https://github.com/livekit/server-sdk-ruby/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -158,7 +197,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="