livekit-server-sdk 0.6.6 → 0.7.1

data/lib/livekit/sip_service_client.rb

@@ -0,0 +1,226 @@
+require "livekit/proto/livekit_sip_twirp"
+require "livekit/auth_mixin"
+require 'livekit/utils'
+
+module LiveKit
+  class SIPServiceClient < Twirp::Client
+    client_for Proto::SIPService
+    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"))
+      @api_key = api_key
+      @api_secret = api_secret
+    end
+
+    def create_sip_inbound_trunk(
+      # name to identify the trunk
+      name,
+      # numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.
+      numbers,
+      # optional, metadata to attach to the trunk
+      metadata: nil,
+      # optional, CIDR or IPs that traffic is accepted from.
+      allowed_addresses: nil,
+      # CIDR or IPs that traffic is accepted from.
+      allowed_numbers: nil,
+      # optional, Username and password used to authenticate inbound SIP invites.
+      auth_username: nil,
+      auth_password: nil,
+      # optional, include these SIP X-* headers in 200 OK responses.
+      headers: nil,
+      # optional map SIP X-* headers from INVITE to SIP participant attributes.
+      headers_to_attributes: nil
+    )
+      request = Proto::CreateSIPInboundTrunkRequest.new(
+        trunk: Proto::SIPInboundTrunkInfo.new(
+          name: name,
+          metadata: metadata,
+          numbers: numbers,
+          allowed_addresses: allowed_addresses,
+          allowed_numbers: allowed_numbers,
+          auth_username: auth_username,
+          auth_password: auth_password,
+          headers: headers,
+          headers_to_attributes: headers_to_attributes
+        )
+      )
+      self.rpc(
+        :CreateSIPInboundTrunk,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    def create_sip_outbound_trunk(
+      # name to identify the trunk
+      name,
+      # Hostname or IP that SIP INVITE is sent too.
+      address,
+      # Numbers used to make the calls. Random one from this list will be selected.
+      numbers,
+      # optional, metadata to attach to the trunk
+      metadata: nil,
+      # SIP Transport used for outbound call.
+      transport: nil,
+      # optional, Username and password used to authenticate inbound SIP invites.
+      auth_username: nil,
+      auth_password: nil,
+      # optional, include these SIP X-* headers in 200 OK responses.
+      headers: nil,
+      # optional map SIP X-* headers from INVITE to SIP participant attributes.
+      headers_to_attributes: nil
+    )
+      request = Proto::CreateSIPOutboundTrunkRequest.new(
+        trunk: Proto::SIPOutboundTrunkInfo.new(
+          name: name,
+          address: address,
+          numbers: numbers,
+          metadata: metadata,
+          transport: transport,
+          auth_username: auth_username,
+          auth_password: auth_password,
+          headers: headers,
+          headers_to_attributes: headers_to_attributes
+        )
+      )
+      self.rpc(
+        :CreateSIPOutboundTrunk,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    def list_sip_inbound_trunk
+      request = Proto::ListSIPInboundTrunkRequest.new
+      self.rpc(
+        :ListSIPInboundTrunk,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    def list_sip_outbound_trunk
+      request = Proto::ListSIPOutboundTrunkRequest.new
+      self.rpc(
+        :ListSIPOutboundTrunk,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    def delete_sip_trunk(sip_trunk_id)
+      request = Proto::DeleteSIPTrunkRequest.new(
+        sip_trunk_id: sip_trunk_id,
+      )
+      self.rpc(
+        :DeleteSIPTrunk,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    def create_sip_dispatch_rule(
+      rule,
+      name: nil,
+      trunk_ids: nil,
+      inbound_numbers: nil,
+      hide_phone_number: nil,
+      metadata: nil,
+      attributes: nil
+    )
+      request = Proto::CreateSIPDispatchRuleRequest.new(
+        rule: rule,
+        name: name,
+        trunk_ids: trunk_ids,
+        inbound_numbers: inbound_numbers,
+        hide_phone_number: hide_phone_number,
+        metadata: metadata,
+        attributes: attributes,
+      )
+      self.rpc(
+        :CreateSIPDispatchRule,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    def list_sip_dispatch_rule
+      request = Proto::ListSIPDispatchRuleRequest.new
+      self.rpc(
+        :ListSIPDispatchRule,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    def delete_sip_dispatch_rule(sip_dispatch_rule_id)
+      request = Proto::DeleteSIPDispatchRuleRequest.new(
+        sip_dispatch_rule_id: sip_dispatch_rule_id,
+      )
+      self.rpc(
+        :DeleteSIPDispatchRule,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(admin: true)),
+      )
+    end
+
+    def create_sip_participant(
+      sip_trunk_id,
+      sip_call_to,
+      room_name,
+      participant_identity: nil,
+      participant_name: nil,
+      participant_metadata: nil,
+      dtmf: nil,
+      play_ringtone: nil, # deprecated, use play_dialtone
+      play_dialtone: nil,
+      hide_phone_number: nil
+    )
+
+      if (play_ringtone == true || play_dialtone == true)
+        play_dialtone = true
+        play_ringtone = true
+      end
+
+      request = Proto::CreateSIPParticipantRequest.new(
+        sip_trunk_id: sip_trunk_id,
+        sip_call_to: sip_call_to,
+        room_name: room_name,
+        participant_identity: participant_identity,
+        participant_name: participant_name,
+        participant_metadata: participant_metadata,
+        dtmf: dtmf,
+        play_ringtone: play_ringtone,
+        play_dialtone: play_dialtone,
+        hide_phone_number: hide_phone_number,
+      )
+      self.rpc(
+        :CreateSIPParticipant,
+        request,
+        headers: auth_header(sip_grant: SIPGrant.new(call: true)),
+      )
+    end
+
+    def transfer_sip_participant(
+      room_name,
+      participant_identity,
+      transfer_to,
+      play_dialtone: nil
+    )
+
+      request = Proto::TransferSIPParticipantRequest.new(
+        room_name: room_name,
+        participant_identity: participant_identity,
+        transfer_to: transfer_to,
+        play_dialtone: play_dialtone,
+      )
+      self.rpc(
+        :TransferSIPParticipant,
+        request,
+        headers: auth_header(video_grant: VideoGrant.new(roomAdmin: true, room: room_name), sip_grant: SIPGrant.new(call: true)),
+      )
+    end
+  end
+end

data/lib/livekit/version.rb

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

data/lib/livekit.rb

@@ -11,3 +11,4 @@ $LOAD_PATH.unshift(File.expand_path("livekit/proto", __dir__))
 require "livekit/room_service_client"
 require "livekit/egress_service_client"
 require "livekit/ingress_service_client"
+require "livekit/sip_service_client"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: livekit-server-sdk
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.7.1
 platform: ruby
 authors:
 - Omri Gabay
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-12 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -133,10 +133,16 @@ files:
 - lib/livekit/egress_service_client.rb
 - lib/livekit/grants.rb
 - lib/livekit/ingress_service_client.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_egress_pb.rb
 - lib/livekit/proto/livekit_egress_twirp.rb
 - lib/livekit/proto/livekit_ingress_pb.rb
 - lib/livekit/proto/livekit_ingress_twirp.rb
+- lib/livekit/proto/livekit_metrics_pb.rb
+- lib/livekit/proto/livekit_metrics_twirp.rb
 - lib/livekit/proto/livekit_models_pb.rb
 - lib/livekit/proto/livekit_models_twirp.rb
 - lib/livekit/proto/livekit_room_pb.rb
@@ -146,6 +152,7 @@ files:
 - lib/livekit/proto/livekit_webhook_pb.rb
 - lib/livekit/proto/livekit_webhook_twirp.rb
 - lib/livekit/room_service_client.rb
+- lib/livekit/sip_service_client.rb
 - lib/livekit/token_verifier.rb
 - lib/livekit/utils.rb
 - lib/livekit/version.rb