telnyx 5.169.0 → 5.171.0

data/lib/telnyx/models/meeting_session_create_params.rb

@@ -14,10 +14,10 @@ module Telnyx
       required :meeting_url, String
 
       # @!attribute assistant
-      #   Request options for attaching a voice assistant to the session. Routing fields
-      #   (`call_control_connection_id`, `from`, and `loopback_sip_uri`) are used only to
-      #   establish the assistant call leg and are omitted from response objects.
-      #   `audio_gate` is returned with `id` in the assistant response object.
+      #   Attach a Telnyx AI Assistant to the session. Supply the Assistant's ID; the
+      #   Meeting service connects it to the meeting directly. The Call Control
+      #   connection, caller ID and loopback SIP URI previously required here have been
+      #   removed and are now rejected as unknown fields.
       #
       #   @return [Telnyx::Models::MeetingSessionCreateParams::Assistant, nil]
       optional :assistant, -> { Telnyx::MeetingSessionCreateParams::Assistant }
@@ -53,6 +53,16 @@ module Telnyx
       #   @return [Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source, Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageURLSource, nil]
       optional :camera_image, union: -> { Telnyx::MeetingSessionCreateParams::CameraImage }
 
+      # @!attribute chat_on_enter
+      #   A message the bot posts to the meeting's chat as soon as it becomes active —
+      #   typically a recording disclosure. Delivered at most once. Independent of
+      #   `speak_on_enter`: both may be set, and the chat message posts first because it
+      #   does not wait for text-to-speech or avatar startup. Rejected with 422
+      #   `unsupported_capability` on platforms without meeting chat.
+      #
+      #   @return [String, nil]
+      optional :chat_on_enter, String
+
       # @!attribute idempotency_key
       #   Client-supplied idempotency key to safely retry creation requests without
       #   duplicating sessions. Lookup is scoped to the authenticated account and compares
@@ -76,7 +86,10 @@ module Telnyx
       optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
 
       # @!attribute speak_on_enter
-      #   Text the bot speaks when it enters the meeting.
+      #   Text the bot speaks when it enters the meeting. **Not spoken when an `assistant`
+      #   is attached**: the value is accepted and echoed back on the session, but the
+      #   assistant owns the voice and the line is never delivered, with no event
+      #   reporting the omission. Use `chat_on_enter` to announce an assistant-backed bot.
       #
       #   @return [String, nil]
       optional :speak_on_enter, String
@@ -103,13 +116,13 @@ module Telnyx
       #   @return [String, nil]
       optional :webhook_url, String
 
-      # @!method initialize(meeting_url:, assistant: nil, avatar: nil, barge_in: nil, bot_name: nil, camera_image: nil, idempotency_key: nil, join_at: nil, metadata: nil, speak_on_enter: nil, summarize_on_end: nil, voice: nil, webhook_url: nil, request_options: {})
+      # @!method initialize(meeting_url:, assistant: nil, avatar: nil, barge_in: nil, bot_name: nil, camera_image: nil, chat_on_enter: nil, idempotency_key: nil, join_at: nil, metadata: nil, speak_on_enter: nil, summarize_on_end: nil, voice: nil, webhook_url: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MeetingSessionCreateParams} for more details.
       #
       #   @param meeting_url [String] The meeting URL the bot should join.
       #
-      #   @param assistant [Telnyx::Models::MeetingSessionCreateParams::Assistant] Request options for attaching a voice assistant to the session. Routing fields (
+      #   @param assistant [Telnyx::Models::MeetingSessionCreateParams::Assistant] Attach a Telnyx AI Assistant to the session. Supply the Assistant's ID; the Meet
       #
       #   @param avatar [Telnyx::Models::MeetingSessionCreateParams::Avatar] Request options for attaching a bring-your-own-key avatar to the session.
       #
@@ -119,13 +132,16 @@ module Telnyx
       #
       #   @param camera_image [Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source, Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageURLSource] Write-only static camera-tile image for this session, not a native account or pa
       #
+      #   @param chat_on_enter [String] A message the bot posts to the meeting's chat as soon as it becomes active — typ
+      #
       #   @param idempotency_key [String] Client-supplied idempotency key to safely retry creation requests without duplic
       #
       #   @param join_at [Time] ISO-8601 timestamp in the future at which the bot should join. If omitted, the b
       #
       #   @param metadata [Hash{Symbol=>Object}] Arbitrary key-value metadata attached to the session. The serialized JSON repres
       #
-      #   @param speak_on_enter [String] Text the bot speaks when it enters the meeting.
+      #   @param speak_on_enter [String] Text the bot speaks when it enters the meeting. \*\*Not spoken when an
+      #   `assistant`
       #
       #   @param summarize_on_end [Boolean] If true, generate a summary artifact when the session ends.
       #
@@ -142,54 +158,72 @@ module Telnyx
         #   @return [String]
         required :id, String
 
-        # @!attribute call_control_connection_id
-        #   Call control connection used to bridge the assistant into the meeting audio.
+        # @!attribute audio_gate
+        #   Audio gating strategy for the assistant call leg. `half_duplex` (default) sends
+        #   the assistant a single mixed meeting stream and mutes it while the assistant
+        #   speaks, so the assistant cannot hear itself and cannot be interrupted.
+        #   `full_duplex` sends a separate stream per participant, which allows barge-in and
+        #   removes self-hearing, and COSTS SIGNIFICANTLY MORE: per-participant streams
+        #   multiply the per-minute cost by the number of participants.
         #
-        #   @return [String]
-        required :call_control_connection_id, String
+        #   @return [Symbol, Telnyx::Models::MeetingSessionCreateParams::Assistant::AudioGate, nil]
+        optional :audio_gate, enum: -> { Telnyx::MeetingSessionCreateParams::Assistant::AudioGate }
 
-        # @!attribute from
-        #   E.164 calling number used as the originating party for the assistant call leg.
+        # @!attribute dynamic_variables
+        #   Per-conversation values for the
+        #   [dynamic variables](/docs/inference/ai-assistants/dynamic-variables) used in the
+        #   Assistant's instructions, greeting, or tools. Delivered before the Assistant's
+        #   first utterance, so they resolve for the opening line as well as the rest of the
+        #   conversation. At most 63 entries; keys 1-128 characters; values must be strings.
+        #   The map is budgeted in aggregate at 1,047,552 bytes (1023 KiB) rather than
+        #   capped per value. `streaming_audio`, `ai_assistant_streaming_audio` and
+        #   `meeting_session_id` are reserved and rejected with `400 invalid_request` --
+        #   they toggle provider infrastructure or are set by the service rather than fill a
+        #   prompt template.
         #
-        #   @return [String]
-        required :from, String
-
-        # @!attribute loopback_sip_uri
-        #   SIP URI to which the assistant media loopback is established.
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :dynamic_variables, Telnyx::Internal::Type::HashOf[String]
+
+        # @!attribute leave_on_end
+        #   Leave the meeting when the Assistant's conversation reaches a terminal state --
+        #   `ended` **or** `failed`. Off by default, which leaves the bot in the meeting
+        #   after the Assistant stops. Fires once: a second terminal transition does not
+        #   leave twice, and a leave the provider refuses is logged without changing how the
+        #   session settles.
         #
-        #   @return [String]
-        required :loopback_sip_uri, String
+        #   @return [Boolean, nil]
+        optional :leave_on_end, Telnyx::Internal::Type::Boolean
 
-        # @!attribute audio_gate
-        #   Audio gating strategy for the assistant call leg.
+        # @!method initialize(id:, audio_gate: nil, dynamic_variables: nil, leave_on_end: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::MeetingSessionCreateParams::Assistant} for more details.
         #
-        #   @return [Symbol, Telnyx::Models::MeetingSessionCreateParams::Assistant::AudioGate, nil]
-        optional :audio_gate, enum: -> { Telnyx::MeetingSessionCreateParams::Assistant::AudioGate }
-
-        # @!method initialize(id:, call_control_connection_id:, from:, loopback_sip_uri:, audio_gate: nil)
-        #   Request options for attaching a voice assistant to the session. Routing fields
-        #   (`call_control_connection_id`, `from`, and `loopback_sip_uri`) are used only to
-        #   establish the assistant call leg and are omitted from response objects.
-        #   `audio_gate` is returned with `id` in the assistant response object.
+        #   Attach a Telnyx AI Assistant to the session. Supply the Assistant's ID; the
+        #   Meeting service connects it to the meeting directly. The Call Control
+        #   connection, caller ID and loopback SIP URI previously required here have been
+        #   removed and are now rejected as unknown fields.
         #
         #   @param id [String] Identifier of the assistant to attach.
         #
-        #   @param call_control_connection_id [String] Call control connection used to bridge the assistant into the meeting audio.
+        #   @param audio_gate [Symbol, Telnyx::Models::MeetingSessionCreateParams::Assistant::AudioGate] Audio gating strategy for the assistant call leg. `half_duplex` (default) sends
         #
-        #   @param from [String] E.164 calling number used as the originating party for the assistant call leg.
+        #   @param dynamic_variables [Hash{Symbol=>String}] Per-conversation values for the [dynamic variables](/docs/inference/ai-assistant
         #
-        #   @param loopback_sip_uri [String] SIP URI to which the assistant media loopback is established.
-        #
-        #   @param audio_gate [Symbol, Telnyx::Models::MeetingSessionCreateParams::Assistant::AudioGate] Audio gating strategy for the assistant call leg.
-
-        # Audio gating strategy for the assistant call leg.
+        #   @param leave_on_end [Boolean] Leave the meeting when the Assistant's conversation reaches a terminal state --
+
+        # Audio gating strategy for the assistant call leg. `half_duplex` (default) sends
+        # the assistant a single mixed meeting stream and mutes it while the assistant
+        # speaks, so the assistant cannot hear itself and cannot be interrupted.
+        # `full_duplex` sends a separate stream per participant, which allows barge-in and
+        # removes self-hearing, and COSTS SIGNIFICANTLY MORE: per-participant streams
+        # multiply the per-minute cost by the number of participants.
         #
         # @see Telnyx::Models::MeetingSessionCreateParams::Assistant#audio_gate
         module AudioGate
           extend Telnyx::Internal::Type::Enum
 
-          NONE = :none
           HALF_DUPLEX = :half_duplex
+          FULL_DUPLEX = :full_duplex
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/telnyx/models/meeting_session_delete_recording_media_response.rb

@@ -28,20 +28,20 @@ module Telnyx
 
         # @!attribute provider
         #
-        #   @return [Symbol, :recall]
-        required :provider, const: :recall
+        #   @return [Symbol, :telnyx]
+        required :provider, const: :telnyx
 
         # @!attribute scope
         #
         #   @return [Symbol, :provider_recording_media]
         required :scope, const: :provider_recording_media
 
-        # @!method initialize(deletion_status:, meeting_session_id:, provider: :recall, scope: :provider_recording_media)
+        # @!method initialize(deletion_status:, meeting_session_id:, provider: :telnyx, scope: :provider_recording_media)
         #   @param deletion_status [Symbol, Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data::DeletionStatus]
         #
         #   @param meeting_session_id [String] The account-scoped Meeting Session identifier.
         #
-        #   @param provider [Symbol, :recall]
+        #   @param provider [Symbol, :telnyx]
         #
         #   @param scope [Symbol, :provider_recording_media]
 

data/lib/telnyx/models/meeting_session_retrieve_recordings_response.rb

@@ -15,8 +15,7 @@ module Telnyx
 
       class Data < Telnyx::Internal::Type::BaseModel
         # @!attribute expires_at
-        #   Expiry timestamp when supplied by the provider, or null. The current adapter
-        #   returns null.
+        #   Expiry timestamp when available, or null. Currently returns null.
         #
         #   @return [String, nil]
         required :expires_at, String, nil?: true
@@ -38,7 +37,7 @@ module Telnyx
         #   {Telnyx::Models::MeetingSessionRetrieveRecordingsResponse::Data} for more
         #   details.
         #
-        #   @param expires_at [String, nil] Expiry timestamp when supplied by the provider, or null. The current adapter ret
+        #   @param expires_at [String, nil] Expiry timestamp when available, or null. Currently returns null.
         #
         #   @param type [String]
         #

data/lib/telnyx/models/meeting_sessions/artifact_create_params.rb

@@ -13,28 +13,92 @@ module Telnyx
         #   @return [String]
         required :id, String
 
-        # @!attribute type
-        #   Type of artifact to generate from the session.
+        # @!attribute body
+        #   One of two shapes: a named type on its own, or `custom` with the prompt it
+        #   answers.
         #
-        #   @return [Symbol, Telnyx::Models::MeetingSessions::ArtifactCreateParams::Type]
-        required :type, enum: -> { Telnyx::MeetingSessions::ArtifactCreateParams::Type }
+        #   @return [Telnyx::Models::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact, Telnyx::Models::MeetingSessions::ArtifactCreateParams::Body::CustomArtifact]
+        required :body, union: -> { Telnyx::MeetingSessions::ArtifactCreateParams::Body }
 
-        # @!method initialize(id:, type:, request_options: {})
+        # @!method initialize(id:, body:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::MeetingSessions::ArtifactCreateParams} for more details.
+        #
         #   @param id [String]
         #
-        #   @param type [Symbol, Telnyx::Models::MeetingSessions::ArtifactCreateParams::Type] Type of artifact to generate from the session.
+        #   @param body [Telnyx::Models::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact, Telnyx::Models::MeetingSessions::ArtifactCreateParams::Body::CustomArtifact] One of two shapes: a named type on its own, or `custom` with the prompt it answe
         #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
-        # Type of artifact to generate from the session.
-        module Type
-          extend Telnyx::Internal::Type::Enum
+        # One of two shapes: a named type on its own, or `custom` with the prompt it
+        # answers.
+        module Body
+          extend Telnyx::Internal::Type::Union
+
+          variant -> { Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact }
+
+          variant -> { Telnyx::MeetingSessions::ArtifactCreateParams::Body::CustomArtifact }
+
+          class NamedArtifact < Telnyx::Internal::Type::BaseModel
+            # @!attribute type
+            #   What to generate from the transcript. `custom` is answered from a `prompt` you
+            #   supply; the five named types need none.
+            #
+            #   @return [Symbol, Telnyx::Models::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type]
+            required :type, enum: -> { Telnyx::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type }
+
+            # @!method initialize(type:)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact} for
+            #   more details.
+            #
+            #   @param type [Symbol, Telnyx::Models::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact::Type] What to generate from the transcript. `custom` is answered from a `prompt` you s
+
+            # What to generate from the transcript. `custom` is answered from a `prompt` you
+            # supply; the five named types need none.
+            #
+            # @see Telnyx::Models::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact#type
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              SUMMARY = :summary
+              ACTION_ITEMS = :action_items
+              DECISIONS = :decisions
+              TOPICS = :topics
+              OPEN_QUESTIONS = :open_questions
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class CustomArtifact < Telnyx::Internal::Type::BaseModel
+            # @!attribute prompt
+            #   An open-ended request answered from the transcript. Required when `type` is
+            #   `custom`, and rejected with 400 on any named type. Trimmed before storage and
+            #   echoed back in artifact responses and the `artifact.completed` webhook.
+            #
+            #   @return [String]
+            required :prompt, String
+
+            # @!attribute type
+            #   Answered from the `prompt` below rather than a fixed question.
+            #
+            #   @return [Symbol, :custom]
+            required :type, const: :custom
 
-          SUMMARY = :summary
-          ACTION_ITEMS = :action_items
+            # @!method initialize(prompt:, type: :custom)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::MeetingSessions::ArtifactCreateParams::Body::CustomArtifact}
+            #   for more details.
+            #
+            #   @param prompt [String] An open-ended request answered from the transcript. Required when `type` is `cus
+            #
+            #   @param type [Symbol, :custom] Answered from the `prompt` below rather than a fixed question.
+          end
 
-          # @!method self.values
-          #   @return [Array<Symbol>]
+          # @!method self.variants
+          #   @return [Array(Telnyx::Models::MeetingSessions::ArtifactCreateParams::Body::NamedArtifact, Telnyx::Models::MeetingSessions::ArtifactCreateParams::Body::CustomArtifact)]
         end
       end
     end

data/lib/telnyx/models/meeting_sessions/meeting_session_artifact.rb

@@ -31,6 +31,13 @@ module Telnyx
                  -> { Telnyx::MeetingSessions::MeetingSessionArtifact::ModelProvenance },
                  nil?: true
 
+        # @!attribute prompt
+        #   The prompt that produced this artifact, or null for a named type. Non-null only
+        #   when `type` is `custom`; the five named types always return `null`.
+        #
+        #   @return [String, nil]
+        required :prompt, String, nil?: true
+
         # @!attribute session_id
         #
         #   @return [String]
@@ -51,15 +58,28 @@ module Telnyx
         #   @return [Time]
         required :updated_at, Time
 
-        # @!method initialize(id:, content:, created_at:, failure_reason:, model_provenance:, session_id:, status:, type:, updated_at:)
+        # @!method initialize(id:, content:, created_at:, failure_reason:, model_provenance:, prompt:, session_id:, status:, type:, updated_at:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::MeetingSessions::MeetingSessionArtifact} for more details.
+        #
         #   @param id [String]
+        #
         #   @param content [Telnyx::Models::MeetingSessions::MeetingSessionArtifact::Content, nil]
+        #
         #   @param created_at [Time]
+        #
         #   @param failure_reason [String, nil]
+        #
         #   @param model_provenance [Telnyx::Models::MeetingSessions::MeetingSessionArtifact::ModelProvenance, nil]
+        #
+        #   @param prompt [String, nil] The prompt that produced this artifact, or null for a named type. Non-null only
+        #
         #   @param session_id [String]
+        #
         #   @param status [Symbol, Telnyx::Models::MeetingSessions::MeetingSessionArtifact::Status]
+        #
         #   @param type [Symbol, Telnyx::Models::MeetingSessions::MeetingSessionArtifact::Type]
+        #
         #   @param updated_at [Time]
 
         # @see Telnyx::Models::MeetingSessions::MeetingSessionArtifact#content
@@ -108,6 +128,10 @@ module Telnyx
 
           SUMMARY = :summary
           ACTION_ITEMS = :action_items
+          DECISIONS = :decisions
+          TOPICS = :topics
+          OPEN_QUESTIONS = :open_questions
+          CUSTOM = :custom
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/telnyx/models/message_event.rb

@@ -4,12 +4,38 @@ module Telnyx
   module Models
     # @see Telnyx::Resources::EmailMessages#retrieve_events
     class MessageEvent < Telnyx::Internal::Type::BaseModel
+      # @!attribute canonical_event_type
+      #   Additive canonical outcome name, prefixed with `email.`. Gateway rejection is
+      #   `email.gw_reject`, ambiguous injection timeout is `email.injection_timeout`, and
+      #   MTA expiration is `email.expired`. Unchanged outcomes retain their names.
+      #   Existing stored rows are translated only when recorded payload evidence proves
+      #   the outcome; a legacy failed row is not guessed or sharpened.
+      #
+      #   @return [String]
+      required :canonical_event_type, String
+
+      # @!attribute event_type
+      #   Legacy customer-visible event name, prefixed with `email.`. Gateway rejections
+      #   render `email.failed`; MTA expirations render `email.bounced`. Webhook
+      #   subscription allowlists match the legacy name.
+      #
+      #   @return [String]
+      required :event_type, String
+
       # @!attribute occurred_at
       #
       #   @return [Time]
       required :occurred_at, Time
 
       # @!attribute type
+      #   @deprecated
+      #
+      #   Bare stored event names returned by message history. In addition to the normal
+      #   send and delivery lifecycle, polling can expose suppression, scan, and
+      #   quarantine lifecycle rows. Sharp canonical names gw_reject, injection_timeout,
+      #   and expired distinguish gateway rejection, ambiguous injection timeout, and MTA
+      #   expiration. The failed and bounced names remain valid for system/admin failures
+      #   and hard bounces respectively. Existing stored rows retain their original names.
       #
       #   @return [Symbol, Telnyx::Models::EmailEventType]
       required :type, enum: -> { Telnyx::EmailEventType }
@@ -19,9 +45,22 @@ module Telnyx
       #   @return [Hash{Symbol=>Object}, nil]
       optional :payload, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
 
-      # @!method initialize(occurred_at:, type:, payload: nil)
+      # @!method initialize(canonical_event_type:, event_type:, occurred_at:, type:, payload: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::MessageEvent} for more details.
+      #
+      #   An event on the per-message events endpoint. The legacy event_type and additive
+      #   canonical_event_type are email.-prefixed. The deprecated type preserves the bare
+      #   stored event name for compatibility.
+      #
+      #   @param canonical_event_type [String] Additive canonical outcome name, prefixed with `email.`. Gateway rejection is `e
+      #
+      #   @param event_type [String] Legacy customer-visible event name, prefixed with `email.`. Gateway rejections r
+      #
       #   @param occurred_at [Time]
-      #   @param type [Symbol, Telnyx::Models::EmailEventType]
+      #
+      #   @param type [Symbol, Telnyx::Models::EmailEventType] Bare stored event names returned by message history. In addition to the normal s
+      #
       #   @param payload [Hash{Symbol=>Object}]
     end
   end

data/lib/telnyx/models/model_metadata.rb

@@ -93,8 +93,14 @@ module Telnyx
       optional :is_vision_supported, Telnyx::Internal::Type::Boolean
 
       # @!attribute max_completion_tokens
-      #   Maximum number of completion (output) tokens the model will generate per
-      #   request. `null` if unconstrained beyond `context_length`.
+      #   Model-specific completion-token ceiling. For Chat Completions, this value clamps
+      #   explicit output limits and the 8192 default when that default applies. Models
+      #   excluded from the default leave an omitted or null output limit unset for the
+      #   serving engine, even when this metadata declares a ceiling; see
+      #   `ChatCompletionRequest.max_tokens` for the hosted default and exclusion lists.
+      #   This field does not report the effective default. `null` means no separate
+      #   completion ceiling is declared; input and output together must still fit
+      #   `context_length`.
       #
       #   @return [Integer, nil]
       optional :max_completion_tokens, Integer, nil?: true
@@ -186,7 +192,7 @@ module Telnyx
       #
       #   @param is_vision_supported [Boolean] Whether the model accepts image inputs in chat completions (multimodal vision su
       #
-      #   @param max_completion_tokens [Integer, nil] Maximum number of completion (output) tokens the model will generate per request
+      #   @param max_completion_tokens [Integer, nil] Model-specific completion-token ceiling. For Chat Completions, this value clamps
       #
       #   @param object [String] Object type. Always `model`.
       #

data/lib/telnyx/models/number_reputation_external_verification_status_changed_webhook_event.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class NumberReputationExternalVerificationStatusChangedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data]
+      required :data, -> { Telnyx::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data }
+
+      # @!attribute meta
+      #
+      #   @return [Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Meta]
+      required :meta, -> { Telnyx::NumberReputationExternalVerificationStatusChangedWebhookEvent::Meta }
+
+      # @!method initialize(data:, meta:)
+      #   @param data [Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data]
+      #   @param meta [Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Meta]
+
+      # @see Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Identifies the event; the same id is reused if the event is redelivered.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute event_type
+        #
+        #   @return [Symbol, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::EventType]
+        required :event_type,
+                 enum: -> { Telnyx::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::EventType }
+
+        # @!attribute occurred_at
+        #
+        #   @return [Time]
+        required :occurred_at, Time
+
+        # @!attribute payload
+        #
+        #   @return [Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::Payload]
+        required :payload,
+                 -> { Telnyx::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::Payload }
+
+        # @!attribute record_type
+        #
+        #   @return [Symbol, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::RecordType]
+        required :record_type,
+                 enum: -> { Telnyx::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::RecordType }
+
+        # @!method initialize(id:, event_type:, occurred_at:, payload:, record_type:)
+        #   @param id [String] Identifies the event; the same id is reused if the event is redelivered.
+        #
+        #   @param event_type [Symbol, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::EventType]
+        #
+        #   @param occurred_at [Time]
+        #
+        #   @param payload [Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::Payload]
+        #
+        #   @param record_type [Symbol, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::RecordType]
+
+        # @see Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data#event_type
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          NUMBER_REPUTATION_EXTERNAL_VERIFICATION_STATUS_CHANGED =
+            :"number_reputation.external_verification.status_changed"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data#payload
+        class Payload < Telnyx::Internal::Type::BaseModel
+          # @!attribute enterprise_id
+          #
+          #   @return [String]
+          required :enterprise_id, String
+
+          # @!attribute record_type
+          #
+          #   @return [Symbol, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::Payload::RecordType]
+          required :record_type,
+                   enum: -> { Telnyx::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::Payload::RecordType }
+
+          # @!attribute reviewed_at
+          #   When the review decision was made. Always set: this event is only sent after a
+          #   review.
+          #
+          #   @return [Time]
+          required :reviewed_at, Time
+
+          # @!attribute status
+          #   The review outcome. `pending` is never delivered: the event is sent only once
+          #   the proof is reviewed.
+          #
+          #   @return [Symbol, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::Payload::Status]
+          required :status,
+                   enum: -> { Telnyx::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::Payload::Status }
+
+          # @!attribute rejection_reason
+          #   Set only when `status` is `rejected`.
+          #
+          #   @return [String, nil]
+          optional :rejection_reason, String, nil?: true
+
+          # @!method initialize(enterprise_id:, record_type:, reviewed_at:, status:, rejection_reason: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::Payload}
+          #   for more details.
+          #
+          #   @param enterprise_id [String]
+          #
+          #   @param record_type [Symbol, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::Payload::RecordType]
+          #
+          #   @param reviewed_at [Time] When the review decision was made. Always set: this event is only sent after a r
+          #
+          #   @param status [Symbol, Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::Payload::Status] The review outcome. `pending` is never delivered: the event is sent only once th
+          #
+          #   @param rejection_reason [String, nil] Set only when `status` is `rejected`.
+
+          # @see Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::Payload#record_type
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            REPUTATION_EXTERNAL_VERIFICATION = :reputation_external_verification
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The review outcome. `pending` is never delivered: the event is sent only once
+          # the proof is reviewed.
+          #
+          # @see Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data::Payload#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            APPROVED = :approved
+            REJECTED = :rejected
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EVENT = :event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent#meta
+      class Meta < Telnyx::Internal::Type::BaseModel
+        # @!attribute attempt
+        #
+        #   @return [Integer]
+        required :attempt, Integer
+
+        # @!attribute delivered_to
+        #
+        #   @return [String]
+        required :delivered_to, String
+
+        # @!method initialize(attempt:, delivered_to:)
+        #   @param attempt [Integer]
+        #   @param delivered_to [String]
+      end
+    end
+  end
+end