rcs 2.0.20 → 2.0.22.pre.rc.1

data/lib/pinnacle/network/requests/client.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Network
+    module Requests
+      class Client
+        # @param client [Pinnacle::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # List Network API request records for your team, sorted newest first. Use filters to audit recent checks by
+        # type, status, or your own `clientRef`.
+        #
+        # <Note>
+        #   Limited availability. Contact [founders@pinnacle.sh](mailto:founders@pinnacle.sh) to request access.
+        # </Note>
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Network::Requests::Types::ListNetworkRequestsParams]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
+        # @return [Pinnacle::Types::ListNetworkRequestsResponse]
+        def list(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "network/requests/list",
+            body: Pinnacle::Network::Requests::Types::ListNetworkRequestsParams.new(params).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Types::ListNetworkRequestsResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Retrieve one Network API request by ID. The response includes lifecycle timestamps, request status, your
+        # `clientRef`, and result fields from the original check.
+        #
+        # <Note>
+        #   Limited availability. Contact [founders@pinnacle.sh](mailto:founders@pinnacle.sh) to request access.
+        # </Note>
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [Pinnacle::Types::NetworkRequestId] :request_id
+        #
+        # @return [Pinnacle::Types::NetworkRequestSummary]
+        def get(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "network/requests/#{URI.encode_uri_component(params[:request_id].to_s)}",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Types::NetworkRequestSummary.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/network/requests/types/list_network_requests_params.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Network
+    module Requests
+      module Types
+        class ListNetworkRequestsParams < Internal::Types::Model
+          field :page_index, -> { Integer }, optional: true, nullable: false, api_name: "pageIndex"
+
+          field :page_size, -> { Integer }, optional: true, nullable: false, api_name: "pageSize"
+
+          field :type, -> { Pinnacle::Types::NetworkRequestType }, optional: true, nullable: false
+
+          field :status, -> { Pinnacle::Types::NetworkRequestStatus }, optional: true, nullable: false
+
+          field :client_ref, -> { String }, optional: true, nullable: false, api_name: "clientRef"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/network/silent_auth/client.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Network
+    module SilentAuth
+      class Client
+        # @param client [Pinnacle::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Start a Silent Authentication session to verify that the user controls the device attached to a phone number.
+        # Omit `format` to receive a `browserUrl` for the hosted browser/WebView flow, or set `format: "json"` to
+        # receive a `jsonUrl` for a native mobile app or custom client-side flow. The device check must run from the
+        # user's cellular device, not your server.
+        #
+        # The returned URL expires 60 seconds after creation. Open or fetch it immediately and use `expiresAt` to detect
+        # when a new Silent Auth session is required.
+        #
+        # <Note>
+        #   Limited availability. Contact [founders@pinnacle.sh](mailto:founders@pinnacle.sh) to request access.
+        # </Note>
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Network::SilentAuth::Types::SilentAuthRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
+        # @return [Pinnacle::Types::SilentAuthResponse]
+        def start(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "network/silent-auth",
+            body: Pinnacle::Network::SilentAuth::Types::SilentAuthRequest.new(params).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Types::SilentAuthResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Complete a Silent Authentication request by exchanging the code returned from the JSON flow. Call this from
+        # your server after the user's mobile app fetches `jsonUrl`.
+        #
+        # This endpoint returns a terminal verification result. To inspect pending lifecycle states such as `started` or
+        # `challenge-issued`, use [Get Network Request](/api-reference/network/get-network-request).
+        #
+        # <Note>
+        #   Limited availability. Contact [founders@pinnacle.sh](mailto:founders@pinnacle.sh) to request access.
+        # </Note>
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Network::SilentAuth::Types::SilentAuthCheckRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [Pinnacle::Types::NetworkRequestId] :request_id
+        #
+        # @return [Pinnacle::Types::SilentAuthCheckResponse]
+        def check(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request_data = Pinnacle::Network::SilentAuth::Types::SilentAuthCheckRequest.new(params).to_h
+          non_body_param_names = %w[requestId]
+          body = request_data.except(*non_body_param_names)
+
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "network/silent-auth/#{URI.encode_uri_component(params[:request_id].to_s)}/check",
+            body: body,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Types::SilentAuthCheckResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/network/silent_auth/types/silent_auth_check_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Network
+    module SilentAuth
+      module Types
+        class SilentAuthCheckRequest < Internal::Types::Model
+          field :request_id, -> { String }, optional: false, nullable: false, api_name: "requestId"
+
+          field :code, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/network/silent_auth/types/silent_auth_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Network
+    module SilentAuth
+      module Types
+        class SilentAuthRequest < Internal::Types::Model
+          field :phone_number, -> { String }, optional: false, nullable: false, api_name: "phoneNumber"
+
+          field :client_ref, -> { String }, optional: true, nullable: false, api_name: "clientRef"
+
+          field :format, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/network/sim_swap/client.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Network
+    module SimSwap
+      class Client
+        # @param client [Pinnacle::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Check whether a phone number's SIM was changed during a recent lookback window. Use this to flag account
+        # takeover risk before sign-in, password reset, payment, or other sensitive actions.
+        #
+        # <Note>
+        #   Limited availability. Contact [founders@pinnacle.sh](mailto:founders@pinnacle.sh) to request access.
+        # </Note>
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Network::SimSwap::Types::SimSwapRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
+        # @return [Pinnacle::Types::SimSwapResponse]
+        def check(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "network/sim-swap",
+            body: Pinnacle::Network::SimSwap::Types::SimSwapRequest.new(params).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Types::SimSwapResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/network/sim_swap/types/sim_swap_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Network
+    module SimSwap
+      module Types
+        class SimSwapRequest < Internal::Types::Model
+          field :phone_number, -> { String }, optional: false, nullable: false, api_name: "phoneNumber"
+
+          field :period_hours, -> { Integer }, optional: true, nullable: false, api_name: "periodHours"
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/network/subscriber_match/client.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Network
+    module SubscriberMatch
+      class Client
+        # @param client [Pinnacle::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Compare user-provided identity details against the carrier's subscriber record. Results return match strength
+        # per attribute, so you can use partial signals without receiving carrier PII.
+        #
+        # <Note>
+        #   Limited availability. Contact [founders@pinnacle.sh](mailto:founders@pinnacle.sh) to request access.
+        # </Note>
+        #
+        # @param request_options [Hash]
+        # @param params [Pinnacle::Network::SubscriberMatch::Types::SubscriberMatchRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
+        # @return [Pinnacle::Types::SubscriberMatchResponse]
+        def check(request_options: {}, **params)
+          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
+          request = Pinnacle::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "network/subscriber-match",
+            body: Pinnacle::Network::SubscriberMatch::Types::SubscriberMatchRequest.new(params).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Pinnacle::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Pinnacle::Types::SubscriberMatchResponse.load(response.body)
+          else
+            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/network/subscriber_match/types/subscriber_match_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Network
+    module SubscriberMatch
+      module Types
+        class SubscriberMatchRequest < Internal::Types::Model
+          field :phone_number, -> { String }, optional: false, nullable: false, api_name: "phoneNumber"
+
+          field :attributes, -> { Pinnacle::Types::SubscriberMatchAttributes }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/pinnacle/types/add_conference_participant_params.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Either dial someone (`to` + `from`) or pull in an existing call (`call_id`). `muted` and `whisper_to` can't be
+    # combined.
+    class AddConferenceParticipantParams < Internal::Types::Model
+      extend Pinnacle::Internal::Types::Union
+
+      member -> { Pinnacle::Types::Dial }
+
+      member -> { Pinnacle::Types::ExistingCallParticipantParams }
+    end
+  end
+end

data/lib/pinnacle/types/agent_summary_carrier_launches.rb

@@ -5,7 +5,7 @@ module Pinnacle
     # Raw per-carrier launch + verification state for the agent. Each
     # value is tri-state — `null` means "no launch requested" or "not
     # sent yet"; `false` means "pending" / "sent"; `true` means
-    # "launched" / "verified". Use the [GET /rcs/{agentId}](/api-reference/rcs-agents/get)
+    # "launched" / "verified". Use the [GET /rcs/{agentId}](/api-reference/rcs-agents/get-agent)
     # endpoint for the resolved enum representation.
     class AgentSummaryCarrierLaunches < Internal::Types::Model
       field :att, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "ATT"

data/lib/pinnacle/types/call.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class Call < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :state, -> { Pinnacle::Types::CallState }, optional: false, nullable: false
+
+      field :direction, -> { Pinnacle::Types::CallDirection }, optional: false, nullable: false
+
+      field :to, -> { String }, optional: false, nullable: false
+
+      field :from, -> { String }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :started_at, -> { String }, optional: false, nullable: true
+
+      field :answered_at, -> { String }, optional: false, nullable: true
+
+      field :ended_at, -> { String }, optional: false, nullable: true
+
+      field :metadata, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: false
+
+      field :record, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :recording_state, -> { Pinnacle::Types::RecordingState }, optional: false, nullable: true
+
+      field :hangup_cause, -> { String }, optional: false, nullable: true
+
+      field :conference_id, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/call_direction.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module CallDirection
+      extend Pinnacle::Internal::Types::Enum
+
+      INBOUND = "INBOUND"
+      OUTBOUND = "OUTBOUND"
+    end
+  end
+end

data/lib/pinnacle/types/call_event.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class CallEvent < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :call_session_id, -> { String }, optional: false, nullable: false
+
+      field :event_type, -> { String }, optional: false, nullable: false
+
+      field :source, -> { Pinnacle::Types::CallEventSource }, optional: false, nullable: false
+
+      field :direction, -> { Pinnacle::Types::CallDirection }, optional: false, nullable: true
+
+      field :command_id, -> { String }, optional: false, nullable: true
+
+      field :latency_ms, -> { Integer }, optional: false, nullable: true
+
+      field :occurred_at, -> { String }, optional: false, nullable: false
+
+      field :received_at, -> { String }, optional: false, nullable: false
+
+      field :payload, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/call_event_source.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module CallEventSource
+      extend Pinnacle::Internal::Types::Enum
+
+      WEBHOOK = "WEBHOOK"
+      REST = "REST"
+      WS = "WS"
+      SYSTEM = "SYSTEM"
+    end
+  end
+end

data/lib/pinnacle/types/call_metadata.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module CallMetadata
+      # CallMetadata is an alias for Hash
+
+      # @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/call_state.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module CallState
+      extend Pinnacle::Internal::Types::Enum
+
+      INITIATED = "INITIATED"
+      RINGING = "RINGING"
+      ANSWERED = "ANSWERED"
+      BRIDGED = "BRIDGED"
+      ENDED = "ENDED"
+      FAILED = "FAILED"
+      NO_ANSWER = "NO_ANSWER"
+      BUSY = "BUSY"
+      CANCELED = "CANCELED"
+    end
+  end
+end

data/lib/pinnacle/types/call_status_event.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Voice call lifecycle update delivered to webhooks attached to a phone number.
+    class CallStatusEvent < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :sender, -> { String }, optional: false, nullable: false
+
+      field :call, -> { Pinnacle::Types::CallStatusEventCall }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/call_status_event_call.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class CallStatusEventCall < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :from, -> { String }, optional: false, nullable: false
+
+      field :to, -> { String }, optional: false, nullable: false
+
+      field :direction, -> { Pinnacle::Types::CallDirection }, optional: false, nullable: false
+
+      field :status, -> { Pinnacle::Types::CallState }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/call_stream_token.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class CallStreamToken < Internal::Types::Model
+      field :token, -> { String }, optional: false, nullable: false
+
+      field :expires_at, -> { String }, optional: false, nullable: false
+
+      field :stream_url, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/conference.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class Conference < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :label, -> { String }, optional: false, nullable: true
+
+      field :status, -> { Pinnacle::Types::ConferenceStatus }, optional: false, nullable: false
+
+      field :participant_count, -> { Integer }, optional: false, nullable: false
+
+      field :max_participants, -> { Integer }, optional: false, nullable: false
+
+      field :hold_audio_url, -> { String }, optional: false, nullable: true
+
+      field :speaking_events, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :metadata, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :started_at, -> { String }, optional: false, nullable: true
+
+      field :ended_at, -> { String }, optional: false, nullable: true
+
+      field :ended_reason, -> { Pinnacle::Types::ConferenceEndedReason }, optional: false, nullable: true
+
+      field :participants, -> { Internal::Types::Array[Pinnacle::Types::ConferenceParticipant] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/conference_ended_reason.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module ConferenceEndedReason
+      extend Pinnacle::Internal::Types::Enum
+
+      EMPTY = "empty"
+      ENDED_BY_API = "ended_by_api"
+      PARTICIPANT_ENDED_IT = "participant_ended_it"
+      TIME_LIMIT = "time_limit"
+      EXPIRED_WAITING = "expired_waiting"
+      FAILED = "failed"
+    end
+  end
+end