rcs 2.0.19 → 2.0.20.pre.rc.1

data/lib/pinnacle/types/network_request_id.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module NetworkRequestId
+      # NetworkRequestId is an alias for String
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/pinnacle/types/network_request_result.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Result from the original check, or null while the request is still pending or no result is available.
+    class NetworkRequestResult < Internal::Types::Model
+      extend Pinnacle::Internal::Types::Union
+
+      member -> { Pinnacle::Types::SimSwapResponse }
+
+      member -> { Pinnacle::Types::SubscriberMatchResponse }
+
+      member -> { Pinnacle::Types::SilentAuthCheckResponse }
+    end
+  end
+end

data/lib/pinnacle/types/network_request_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module NetworkRequestStatus
+      extend Pinnacle::Internal::Types::Enum
+
+      STARTED = "started"
+      CHALLENGE_ISSUED = "challenge-issued"
+      COMPLETED = "completed"
+      FAILED = "failed"
+      EXPIRED = "expired"
+    end
+  end
+end

data/lib/pinnacle/types/network_request_summary.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class NetworkRequestSummary < Internal::Types::Model
+      field :request_id, -> { String }, optional: false, nullable: false, api_name: "requestId"
+
+      field :type, -> { Pinnacle::Types::NetworkRequestType }, optional: false, nullable: false
+
+      field :status, -> { Pinnacle::Types::NetworkRequestStatus }, optional: false, nullable: false
+
+      field :client_ref, -> { String }, optional: false, nullable: true, api_name: "clientRef"
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
+
+      field :completed_at, -> { String }, optional: false, nullable: true, api_name: "completedAt"
+
+      field :expires_at, -> { String }, optional: false, nullable: true, api_name: "expiresAt"
+
+      field :error_message, -> { String }, optional: false, nullable: true, api_name: "errorMessage"
+
+      field :result, -> { Pinnacle::Types::NetworkRequestResult }, optional: false, nullable: true
+    end
+  end
+end

data/lib/pinnacle/types/network_request_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module NetworkRequestType
+      extend Pinnacle::Internal::Types::Enum
+
+      SILENT_AUTH = "silent-auth"
+      SIM_SWAP = "sim-swap"
+      SUBSCRIBER_MATCH = "subscriber-match"
+    end
+  end
+end

data/lib/pinnacle/types/recording_download.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class RecordingDownload < Internal::Types::Model
+      field :url, -> { String }, optional: false, nullable: false
+
+      field :expires_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/recording_state.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module RecordingState
+      extend Pinnacle::Internal::Types::Enum
+
+      PENDING = "PENDING"
+      READY = "READY"
+      FAILED = "FAILED"
+      DELETED = "DELETED"
+    end
+  end
+end

data/lib/pinnacle/types/silent_auth_check_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class SilentAuthCheckResponse < Internal::Types::Model
+      field :request_id, -> { String }, optional: false, nullable: false, api_name: "requestId"
+
+      field :status, -> { Pinnacle::Types::SilentAuthCheckResponseStatus }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/silent_auth_check_response_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module SilentAuthCheckResponseStatus
+      extend Pinnacle::Internal::Types::Enum
+
+      COMPLETED = "completed"
+      FAILED = "failed"
+    end
+  end
+end

data/lib/pinnacle/types/silent_auth_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class SilentAuthResponse < Internal::Types::Model
+      extend Pinnacle::Internal::Types::Union
+
+      discriminant :format
+
+      member -> { Pinnacle::Types::HostedSilentAuthResponse }, key: "HOSTED"
+
+      member -> { Pinnacle::Types::JsonSilentAuthResponse }, key: "JSON_"
+    end
+  end
+end

data/lib/pinnacle/types/sim_swap_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class SimSwapResponse < Internal::Types::Model
+      field :request_id, -> { String }, optional: false, nullable: false, api_name: "requestId"
+
+      field :status, -> { Pinnacle::Types::NetworkInsightStatus }, optional: false, nullable: false
+
+      field :sim_swapped, -> { Internal::Types::Boolean }, optional: false, nullable: true, api_name: "simSwapped"
+
+      field :latest_sim_swap_at, -> { String }, optional: false, nullable: true, api_name: "latestSimSwapAt"
+    end
+  end
+end

data/lib/pinnacle/types/subscriber_match_attributes.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # User-provided subscriber details to compare with the carrier record. Provide at least one non-empty field.
+    class SubscriberMatchAttributes < Internal::Types::Model
+      field :id_document, -> { String }, optional: true, nullable: false, api_name: "idDocument"
+
+      field :given_name, -> { String }, optional: true, nullable: false, api_name: "givenName"
+
+      field :family_name, -> { String }, optional: true, nullable: false, api_name: "familyName"
+
+      field :street_name, -> { String }, optional: true, nullable: false, api_name: "streetName"
+
+      field :street_number, -> { String }, optional: true, nullable: false, api_name: "streetNumber"
+
+      field :postal_code, -> { String }, optional: true, nullable: false, api_name: "postalCode"
+
+      field :locality, -> { String }, optional: true, nullable: false
+
+      field :region, -> { String }, optional: true, nullable: false
+
+      field :country, -> { String }, optional: true, nullable: false
+
+      field :street_number_suffix, -> { String }, optional: true, nullable: false, api_name: "streetNumberSuffix"
+
+      field :birthdate, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/subscriber_match_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class SubscriberMatchResponse < Internal::Types::Model
+      field :request_id, -> { String }, optional: false, nullable: false, api_name: "requestId"
+
+      field :status, -> { Pinnacle::Types::NetworkInsightStatus }, optional: false, nullable: false
+
+      field :matches, -> { Pinnacle::Types::SubscriberMatchResponseMatches }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/subscriber_match_response_matches.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Match strength for each evaluated subscriber attribute.
+    #
+    # - `exact`: Carrier record matches the submitted value exactly.
+    # - `high`: Strong match with minor formatting or normalization differences.
+    # - `partial`: Some parts match, but the value is not a strong match.
+    # - `low`: Weak match.
+    # - `none`: Carrier record does not match the submitted value.
+    # - `unavailable`: Carrier could not evaluate this attribute.
+    # - `included-with-address-match`: Attribute was evaluated as part of the overall address match.
+    # - `unknown`: Carrier returned a match value Pinnacle does not recognize yet.
+    class SubscriberMatchResponseMatches < Internal::Types::Model
+      field :id_document, -> { Pinnacle::Types::SubscriberMatchResult }, optional: true, nullable: false, api_name: "idDocument"
+
+      field :given_name, -> { Pinnacle::Types::SubscriberMatchResult }, optional: true, nullable: false, api_name: "givenName"
+
+      field :family_name, -> { Pinnacle::Types::SubscriberMatchResult }, optional: true, nullable: false, api_name: "familyName"
+
+      field :address, -> { Pinnacle::Types::SubscriberMatchResult }, optional: true, nullable: false
+
+      field :street_name, -> { Pinnacle::Types::SubscriberMatchResult }, optional: true, nullable: false, api_name: "streetName"
+
+      field :street_number, -> { Pinnacle::Types::SubscriberMatchResult }, optional: true, nullable: false, api_name: "streetNumber"
+
+      field :postal_code, -> { Pinnacle::Types::SubscriberMatchResult }, optional: true, nullable: false, api_name: "postalCode"
+
+      field :locality, -> { Pinnacle::Types::SubscriberMatchResult }, optional: true, nullable: false
+
+      field :region, -> { Pinnacle::Types::SubscriberMatchResult }, optional: true, nullable: false
+
+      field :country, -> { Pinnacle::Types::SubscriberMatchResult }, optional: true, nullable: false
+
+      field :street_number_suffix, -> { Pinnacle::Types::SubscriberMatchResult }, optional: true, nullable: false, api_name: "streetNumberSuffix"
+
+      field :birthdate, -> { Pinnacle::Types::SubscriberMatchResult }, optional: true, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/subscriber_match_result.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module SubscriberMatchResult
+      extend Pinnacle::Internal::Types::Enum
+
+      EXACT = "exact"
+      HIGH = "high"
+      PARTIAL = "partial"
+      LOW = "low"
+      NONE = "none"
+      UNAVAILABLE = "unavailable"
+      INCLUDED_WITH_ADDRESS_MATCH = "included-with-address-match"
+      UNKNOWN = "unknown"
+    end
+  end
+end

data/lib/pinnacle/types/webhook_event_enum.rb

@@ -10,6 +10,7 @@ module Pinnacle
       USER_TYPING = "USER.TYPING"
       FORM_SUBMISSION = "FORM.SUBMISSION"
       CAMPAIGN_STATUS = "CAMPAIGN.STATUS"
+      CALL_STATUS = "CALL.STATUS"
     end
   end
 end

data/lib/pinnacle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pinnacle
-  VERSION = "2.0.19"
+  VERSION = "2.0.20.pre.rc.1"
 end

data/lib/pinnacle/wrapper/messages/client.rb

@@ -5,6 +5,7 @@ require_relative "../../types/message_event"
 require_relative "../../types/user_event"
 require_relative "../../types/form_submission_event"
 require_relative "../../types/campaign_status_event"
+require_relative "../../types/call_status_event"
 
 module Pinnacle
   module Wrapper
@@ -23,7 +24,7 @@ module Pinnacle
         # @param request [Hash] Request with :headers and :body keys
         # @param secret [String, nil] Webhook secret (falls back to PINNACLE_SIGNING_SECRET env var)
         #
-        # @return [Pinnacle::Types::MessageEvent, Pinnacle::Types::UserEvent, Pinnacle::Types::FormSubmissionEvent, Pinnacle::Types::CampaignStatusEvent]
+        # @return [Pinnacle::Types::MessageEvent, Pinnacle::Types::UserEvent, Pinnacle::Types::FormSubmissionEvent, Pinnacle::Types::CampaignStatusEvent, Pinnacle::Types::CallStatusEvent]
         # @raise [Pinnacle::Errors::UnauthorizedError] If webhook signature is invalid or missing
         # @raise [Pinnacle::Errors::ClientError] If request body cannot be parsed
         def process(request, secret: nil)
@@ -66,6 +67,8 @@ module Pinnacle
             Pinnacle::Types::FormSubmissionEvent.coerce(parsed)
           when "CAMPAIGN.STATUS"
             Pinnacle::Types::CampaignStatusEvent.coerce(parsed)
+          when "CALL.STATUS"
+            Pinnacle::Types::CallStatusEvent.coerce(parsed)
           else
             Pinnacle::Types::MessageEvent.coerce(parsed)
           end

data/lib/pinnacle/wrapper/voice/client.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative "../../calls/client"
+require_relative "voice_socket"
+
+module Pinnacle
+  module Wrapper
+    module Voice
+      class Client
+        DEFAULT_RECONNECT = { enabled: true }.freeze
+
+        class DefaultSocket
+          attr_reader :ready_state
+
+          def initialize(url, protocols = nil)
+            @ready_state = 0
+            @listeners = Hash.new { |hash, key| hash[key] = [] }
+            headers = if protocols.nil?
+                        {}
+                      else
+                        { "Sec-WebSocket-Protocol" => Array(protocols).join(", ") }
+                      end
+            @socket = WebSocket::Client::Simple.connect(url, headers: headers)
+            @socket.on(:open) do |event|
+              @ready_state = 1
+              emit("open", event)
+            end
+            @socket.on(:message) { |message| emit("message", { data: message.data }) }
+            @socket.on(:error) { |error| emit("error", error) }
+            @socket.on(:close) do |event|
+              @ready_state = 3
+              emit("close", event)
+            end
+          end
+
+          def add_event_listener(event, &listener)
+            @listeners[event.to_s] << listener
+          end
+
+          def send(data)
+            @socket.send(data)
+          end
+
+          def close(*)
+            @socket.close
+          end
+
+          private
+
+          def emit(event, payload)
+            @listeners[event].each { |listener| listener.call(payload) }
+          end
+        end
+
+        def initialize(client:)
+          @calls = Pinnacle::Calls::Client.new(client: client)
+        end
+
+        def create_and_connect(
+          to:,
+          from:,
+          record: nil,
+          metadata: nil,
+          token: nil,
+          protocols: nil,
+          reconnect: nil,
+          socket: nil,
+          request_options: {}
+        )
+          call_params = { to: to, from: from }
+          call_params[:record] = record unless record.nil?
+          call_params[:metadata] = metadata unless metadata.nil?
+          call = @calls.create(**call_params, request_options: request_options)
+          connection = connect(
+            call_id: call.id,
+            token: token,
+            protocols: protocols,
+            reconnect: DEFAULT_RECONNECT.merge(reconnect || {}),
+            socket: socket
+          )
+          connection.call = call
+          connection.call_id = call.id
+          connection
+        end
+
+        def connect(call_id:, token: nil, protocols: nil, reconnect: nil, socket: nil)
+          socket_class = socket || default_socket
+          token_params = token || {}
+          stream_token = @calls.create_stream_token(**token_params, id: call_id)
+          create_socket = -> do
+            next_token = @calls.create_stream_token(**token_params, id: call_id)
+            new_socket(socket_class, next_token.stream_url, protocols)
+          end
+
+          VoiceSocket.new(
+            new_socket(socket_class, stream_token.stream_url, protocols),
+            create_socket: create_socket,
+            reconnect: DEFAULT_RECONNECT.merge(reconnect || {})
+          )
+        end
+
+        def connect_stream(stream_url, protocols: nil, reconnect: nil, socket: nil)
+          socket_class = socket || default_socket
+          create_socket = -> { new_socket(socket_class, stream_url, protocols) }
+          VoiceSocket.new(create_socket.call, create_socket: create_socket, reconnect: reconnect)
+        end
+
+        private
+
+        def default_socket
+          require "websocket-client-simple" unless defined?(::WebSocket::Client::Simple)
+          DefaultSocket
+        rescue LoadError => e
+          raise e, "The rcs gem could not load its websocket-client-simple dependency. Reinstall rcs or pass socket: to client.voice.connect."
+        end
+
+        def new_socket(socket_class, stream_url, protocols)
+          return socket_class.new(stream_url) if protocols.nil?
+
+          socket_class.new(stream_url, protocols)
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/wrapper/voice/types.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Wrapper
+    module Voice
+      module Types
+        VOICE_COMMAND_ACTIONS = [
+          CALL_ANSWER = "call.answer",
+          CALL_END = "call.end",
+          CALL_TRANSFER = "call.transfer",
+          RECORDING_START = "recording.start",
+          RECORDING_STOP = "recording.stop",
+          AUDIO_PLAY = "audio.play",
+          AUDIO_STOP = "audio.stop",
+          AUDIO_REDUCE_NOISE = "audio.reduce_noise",
+          INPUT_GET = "input.get",
+          INPUT_CANCEL = "input.cancel",
+          DTMF_SEND = "dtmf.send",
+          CALL_UPDATE_STATE = "call.update_state"
+        ].freeze
+
+        USER_BUSY = "user_busy"
+        CALL_REJECTED = "call_rejected"
+
+        NOISE_DEFAULT = "default"
+        NOISE_KRISP = "krisp"
+        NOISE_AICOUSTICS = "aicoustics"
+
+        DIRECTION_INBOUND = "inbound"
+        DIRECTION_OUTBOUND = "outbound"
+        DIRECTION_BOTH = "both"
+
+        TRACK_INBOUND = "inbound"
+        TRACK_OUTBOUND = "outbound"
+      end
+    end
+  end
+end