rcs 2.0.21 → 2.0.22.pre.rc.1

data/lib/pinnacle/types/conference_participant.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # A call in a conference.
+    class ConferenceParticipant < Internal::Types::Model
+      field :call_id, -> { String }, optional: false, nullable: false
+
+      field :conference_id, -> { String }, optional: false, nullable: false
+
+      field :label, -> { String }, optional: false, nullable: true
+
+      field :status, -> { Pinnacle::Types::ParticipantStatus }, optional: false, nullable: false
+
+      field :from, -> { String }, optional: false, nullable: true
+
+      field :to, -> { String }, optional: false, nullable: true
+
+      field :muted, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :on_hold, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :whisper_to, -> { Internal::Types::Array[String] }, optional: false, nullable: true
+
+      field :end_conference_on_leave, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :joined_at, -> { String }, optional: false, nullable: true
+
+      field :left_at, -> { String }, optional: false, nullable: true
+
+      field :left_reason, -> { Pinnacle::Types::ParticipantLeftReason }, optional: false, nullable: true
+    end
+  end
+end

data/lib/pinnacle/types/conference_status.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module ConferenceStatus
+      extend Pinnacle::Internal::Types::Enum
+
+      WAITING = "waiting"
+      ACTIVE = "active"
+      ENDED = "ended"
+    end
+  end
+end

data/lib/pinnacle/types/created_call.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class CreatedCall < 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 :recording_state, -> { Pinnacle::Types::RecordingState }, optional: false, nullable: true
+
+      field :hangup_cause, -> { String }, optional: false, nullable: true
+
+      field :record, -> { Internal::Types::Boolean }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/dial.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Dial someone new. This creates a new outbound call, exactly like `POST /calls`.
+    class Dial < Internal::Types::Model
+      field :to, -> { String }, optional: false, nullable: false
+
+      field :from, -> { String }, optional: false, nullable: false
+
+      field :label, -> { String }, optional: true, nullable: false
+
+      field :muted, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :on_hold, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :whisper_to, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+      field :end_conference_on_leave, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :announce, -> { Pinnacle::Types::ParticipantAnnounce }, optional: true, nullable: false
+
+      field :ring_timeout_secs, -> { Integer }, optional: true, nullable: false
+
+      field :record, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :metadata, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/e_164_phone_number.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module E164PhoneNumber
+      # E164PhoneNumber 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/existing_call_participant_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Pull in a call your team already has. It must be answered and not in another conference.
+    class ExistingCallParticipantParams < Internal::Types::Model
+      field :call_id, -> { String }, optional: false, nullable: false
+
+      field :label, -> { String }, optional: true, nullable: false
+
+      field :muted, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :on_hold, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :whisper_to, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+      field :end_conference_on_leave, -> { Internal::Types::Boolean }, optional: true, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/hosted_silent_auth_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class HostedSilentAuthResponse < Internal::Types::Model
+      field :request_id, -> { String }, optional: false, nullable: false, api_name: "requestId"
+
+      field :browser_url, -> { String }, optional: false, nullable: false, api_name: "browserUrl"
+
+      field :expires_at, -> { String }, optional: false, nullable: false, api_name: "expiresAt"
+    end
+  end
+end

data/lib/pinnacle/types/json_silent_auth_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class JsonSilentAuthResponse < Internal::Types::Model
+      field :request_id, -> { String }, optional: false, nullable: false, api_name: "requestId"
+
+      field :json_url, -> { String }, optional: false, nullable: false, api_name: "jsonUrl"
+
+      field :expires_at, -> { String }, optional: false, nullable: false, api_name: "expiresAt"
+    end
+  end
+end

data/lib/pinnacle/types/list_call_events_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class ListCallEventsResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[Pinnacle::Types::CallEvent] }, optional: false, nullable: false
+
+      field :next_cursor, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/pinnacle/types/list_calls_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class ListCallsResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[Pinnacle::Types::Call] }, optional: false, nullable: false
+
+      field :next_cursor, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/pinnacle/types/list_conferences_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class ListConferencesResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[Pinnacle::Types::Conference] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/list_network_requests_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class ListNetworkRequestsResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[Pinnacle::Types::NetworkRequestSummary] }, optional: false, nullable: false
+
+      field :has_more, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "hasMore"
+
+      field :count, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/list_participants_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class ListParticipantsResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[Pinnacle::Types::ConferenceParticipant] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/pinnacle/types/network_insight_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module NetworkInsightStatus
+      extend Pinnacle::Internal::Types::Enum
+
+      AVAILABLE = "available"
+      UNAVAILABLE = "unavailable"
+      UNSUPPORTED = "unsupported"
+      FAILED = "failed"
+    end
+  end
+end

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/participant_announce.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Played to a dialed participant when they answer, before they join. Nobody else hears it. If it can't be played,
+    # they join without it.
+    class ParticipantAnnounce < Internal::Types::Model
+      extend Pinnacle::Internal::Types::Union
+
+      member -> { Pinnacle::Types::Speak }
+
+      member -> { Pinnacle::Types::Play }
+    end
+  end
+end

data/lib/pinnacle/types/participant_label.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module ParticipantLabel
+      # ParticipantLabel 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/participant_left_reason.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module ParticipantLeftReason
+      extend Pinnacle::Internal::Types::Enum
+
+      HANGUP = "hangup"
+      REMOVED = "removed"
+      BUSY = "busy"
+      NO_ANSWER = "no_answer"
+      REJECTED = "rejected"
+      FAILED = "failed"
+      CONFERENCE_ENDED = "conference_ended"
+    end
+  end
+end

data/lib/pinnacle/types/participant_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    module ParticipantStatus
+      extend Pinnacle::Internal::Types::Enum
+
+      DIALING = "dialing"
+      RINGING = "ringing"
+      JOINED = "joined"
+      LEFT = "left"
+      FAILED = "failed"
+    end
+  end
+end

data/lib/pinnacle/types/play.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class Play < Internal::Types::Model
+      field :url, -> { String }, optional: false, nullable: false
+    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/speak.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    class Speak < Internal::Types::Model
+      field :text, -> { String }, optional: false, nullable: false
+
+      field :voice, -> { String }, optional: true, nullable: false
+    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