telnyx 5.170.0 → 5.171.0

data/lib/telnyx/models/enterprises/reputation/number_retrieve_ownership_response.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # @see Telnyx::Resources::Enterprises::Reputation::Numbers#retrieve_ownership
+        class NumberRetrieveOwnershipResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data]
+          required :data, -> { Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data }
+
+          # @!method initialize(data:)
+          #   @param data [Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data]
+
+          # @see Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse#data
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute baseline_carrier
+            #   Service provider ID (SPID) of the carrier that held the number when its
+            #   ownership was last established.
+            #
+            #   @return [String, nil]
+            optional :baseline_carrier, String, nil?: true
+
+            # @!attribute baseline_recorded_at
+            #
+            #   @return [Time, nil]
+            optional :baseline_recorded_at, Time, nil?: true
+
+            # @!attribute confirm_by
+            #
+            #   @return [Time, nil]
+            optional :confirm_by, Time, nil?: true
+
+            # @!attribute flag_reason
+            #
+            #   @return [String, nil]
+            optional :flag_reason, String, nil?: true
+
+            # @!attribute history
+            #   Ownership events, most recent first.
+            #
+            #   @return [Array<Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data::History>, nil]
+            optional :history,
+                     -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data::History] }
+
+            # @!attribute last_checked_at
+            #   When ownership of the number was last checked.
+            #
+            #   @return [Time, nil]
+            optional :last_checked_at, Time, nil?: true
+
+            # @!attribute ownership_status
+            #   Result of ongoing ownership checks. `verified`: the number is with the carrier
+            #   on record. `pending_confirmation`: the number's carrier changed, or a periodic
+            #   ownership re-verification is due; confirm you still own it before `confirm_by`.
+            #   `flagged`: a periodic re-verification went unanswered; the number stays
+            #   monitored and is not removed, but confirm ownership
+            #   (`POST .../ownership_confirm`) to return it to `verified`. `removed`: the number
+            #   is no longer monitored; returned by `POST .../ownership_confirm` with
+            #   `still_own: false`, and when listing numbers with
+            #   `filter[ownership_status]=removed`.
+            #
+            #   @return [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationOwnershipStatus, nil]
+            optional :ownership_status, enum: -> { Telnyx::Enterprises::Reputation::ReputationOwnershipStatus }
+
+            # @!attribute phone_number
+            #
+            #   @return [String, nil]
+            optional :phone_number, String
+
+            # @!attribute source
+            #   Where the phone number is hosted. `telnyx`: in your Telnyx inventory.
+            #   `external`: a number you own that is hosted with another provider.
+            #
+            #   @return [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationNumberSource, nil]
+            optional :source, enum: -> { Telnyx::Enterprises::Reputation::ReputationNumberSource }
+
+            # @!method initialize(baseline_carrier: nil, baseline_recorded_at: nil, confirm_by: nil, flag_reason: nil, history: nil, last_checked_at: nil, ownership_status: nil, phone_number: nil, source: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data}
+            #   for more details.
+            #
+            #   @param baseline_carrier [String, nil] Service provider ID (SPID) of the carrier that held the number when its ownershi
+            #
+            #   @param baseline_recorded_at [Time, nil]
+            #
+            #   @param confirm_by [Time, nil]
+            #
+            #   @param flag_reason [String, nil]
+            #
+            #   @param history [Array<Telnyx::Models::Enterprises::Reputation::NumberRetrieveOwnershipResponse::Data::History>] Ownership events, most recent first.
+            #
+            #   @param last_checked_at [Time, nil] When ownership of the number was last checked.
+            #
+            #   @param ownership_status [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationOwnershipStatus] Result of ongoing ownership checks. `verified`: the number is with the carrier o
+            #
+            #   @param phone_number [String]
+            #
+            #   @param source [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationNumberSource] Where the phone number is hosted. `telnyx`: in your Telnyx inventory. `external`
+
+            class History < Telnyx::Internal::Type::BaseModel
+              # @!attribute event_type
+              #   `added`, `check`, `flag`, `confirm` or `removed`.
+              #
+              #   @return [String, nil]
+              optional :event_type, String
+
+              # @!attribute occurred_at
+              #
+              #   @return [Time, nil]
+              optional :occurred_at, Time
+
+              # @!attribute outcome
+              #   What the event found or did, for example `unchanged` or `carrier_changed`.
+              #
+              #   @return [String, nil]
+              optional :outcome, String, nil?: true
+
+              # @!method initialize(event_type: nil, occurred_at: nil, outcome: nil)
+              #   @param event_type [String] `added`, `check`, `flag`, `confirm` or `removed`.
+              #
+              #   @param occurred_at [Time]
+              #
+              #   @param outcome [String, nil] What the event found or did, for example `unchanged` or `carrier_changed`.
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/enterprises/reputation/remediation_request.rb

@@ -57,8 +57,9 @@ module Telnyx
           optional :contact_email, String, nil?: true
 
           # @!attribute results
-          #   Per-category buckets. Populated once results are available. Null while the
-          #   request is still pending.
+          #   Per-category buckets of phone numbers, populated once results are available.
+          #   Empty lists are kept (not omitted) so consumers can iterate without
+          #   null-checking each key.
           #
           #   @return [Telnyx::Models::Enterprises::Reputation::RemediationPerNumberResults, nil]
           optional :results, -> { Telnyx::Enterprises::Reputation::RemediationPerNumberResults }, nil?: true
@@ -102,7 +103,7 @@ module Telnyx
           #
           #   @param contact_email [String, nil]
           #
-          #   @param results [Telnyx::Models::Enterprises::Reputation::RemediationPerNumberResults, nil] Per-category buckets. Populated once results are available. Null while the reque
+          #   @param results [Telnyx::Models::Enterprises::Reputation::RemediationPerNumberResults, nil] Per-category buckets of phone numbers, populated once results are available. Emp
           #
           #   @param tier1_completed_at [Time, nil]
           #

data/lib/telnyx/models/enterprises/reputation/reputation_number_source.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # Where the phone number is hosted. `telnyx`: in your Telnyx inventory.
+        # `external`: a number you own that is hosted with another provider.
+        module ReputationNumberSource
+          extend Telnyx::Internal::Type::Enum
+
+          TELNYX = :telnyx
+          EXTERNAL = :external
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      ReputationNumberSource = Reputation::ReputationNumberSource
+    end
+  end
+end

data/lib/telnyx/models/enterprises/reputation/reputation_ownership_status.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        # Result of ongoing ownership checks. `verified`: the number is with the carrier
+        # on record. `pending_confirmation`: the number's carrier changed, or a periodic
+        # ownership re-verification is due; confirm you still own it before `confirm_by`.
+        # `flagged`: a periodic re-verification went unanswered; the number stays
+        # monitored and is not removed, but confirm ownership
+        # (`POST .../ownership_confirm`) to return it to `verified`. `removed`: the number
+        # is no longer monitored; returned by `POST .../ownership_confirm` with
+        # `still_own: false`, and when listing numbers with
+        # `filter[ownership_status]=removed`.
+        module ReputationOwnershipStatus
+          extend Telnyx::Internal::Type::Enum
+
+          VERIFIED = :verified
+          FLAGGED = :flagged
+          PENDING_CONFIRMATION = :pending_confirmation
+          REMOVED = :removed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      ReputationOwnershipStatus = Reputation::ReputationOwnershipStatus
+    end
+  end
+end

data/lib/telnyx/models/enterprises/reputation/reputation_phone_number.rb

@@ -6,23 +6,77 @@ module Telnyx
       module Reputation
         # @see Telnyx::Resources::Enterprises::Reputation::Numbers#list
         class ReputationPhoneNumber < Telnyx::Internal::Type::BaseModel
+          # @!attribute confirm_by
+          #   Deadline to confirm you still own the number. Set only while `ownership_status`
+          #   is `pending_confirmation`.
+          #
+          #   @return [Time, nil]
+          optional :confirm_by, Time, nil?: true
+
           # @!attribute enterprise_id
           #
           #   @return [String, nil]
           optional :enterprise_id, String
 
+          # @!attribute flag_reason
+          #   Why the number's ownership was flagged. `carrier_changed` when an ownership
+          #   check found the number with a different carrier.
+          #
+          #   @return [String, nil]
+          optional :flag_reason, String, nil?: true
+
+          # @!attribute ownership_status
+          #   Result of ongoing ownership checks. `verified`: the number is with the carrier
+          #   on record. `pending_confirmation`: the number's carrier changed, or a periodic
+          #   ownership re-verification is due; confirm you still own it before `confirm_by`.
+          #   `flagged`: a periodic re-verification went unanswered; the number stays
+          #   monitored and is not removed, but confirm ownership
+          #   (`POST .../ownership_confirm`) to return it to `verified`. `removed`: the number
+          #   is no longer monitored; returned by `POST .../ownership_confirm` with
+          #   `still_own: false`, and when listing numbers with
+          #   `filter[ownership_status]=removed`.
+          #
+          #   @return [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationOwnershipStatus, nil]
+          optional :ownership_status, enum: -> { Telnyx::Enterprises::Reputation::ReputationOwnershipStatus }
+
           # @!attribute phone_number
           #   E.164 with leading `+`.
           #
           #   @return [String, nil]
           optional :phone_number, String
 
+          # @!attribute removal_reason
+          #   Why a number was removed. `ported_away`: you confirmed the number left your
+          #   control after a carrier change. `unconfirmed_ownership`: a carrier change was
+          #   not confirmed before the deadline. `reassigned`: the number was reported as
+          #   permanently disconnected. `customer_reported`: you reported that you no longer
+          #   own the number. `customer_removed`: you removed the number.
+          #
+          #   @return [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason, nil]
+          optional :removal_reason,
+                   enum: -> { Telnyx::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason },
+                   nil?: true
+
+          # @!attribute removed_at
+          #   When the number was removed. Set only for removed numbers.
+          #
+          #   @return [Time, nil]
+          optional :removed_at, Time, nil?: true
+
           # @!attribute reputation_data
-          #   `null` until the first refresh has been collected for this number.
+          #   Reputation snapshot for a phone number. Each metric is a 0–100 score;
+          #   `spam_risk` is a coarse bucket. Field set may grow over time - read by key.
           #
           #   @return [Telnyx::Models::ReputationData, nil]
           optional :reputation_data, -> { Telnyx::ReputationData }, nil?: true
 
+          # @!attribute source
+          #   Where the phone number is hosted. `telnyx`: in your Telnyx inventory.
+          #   `external`: a number you own that is hosted with another provider.
+          #
+          #   @return [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationNumberSource, nil]
+          optional :source, enum: -> { Telnyx::Enterprises::Reputation::ReputationNumberSource }
+
           response_only do
             # @!attribute id
             #
@@ -40,18 +94,54 @@ module Telnyx
             optional :updated_at, Time
           end
 
-          # @!method initialize(id: nil, created_at: nil, enterprise_id: nil, phone_number: nil, reputation_data: nil, updated_at: nil)
+          # @!method initialize(id: nil, confirm_by: nil, created_at: nil, enterprise_id: nil, flag_reason: nil, ownership_status: nil, phone_number: nil, removal_reason: nil, removed_at: nil, reputation_data: nil, source: nil, updated_at: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Enterprises::Reputation::ReputationPhoneNumber} for more
+          #   details.
+          #
           #   @param id [String]
           #
+          #   @param confirm_by [Time, nil] Deadline to confirm you still own the number. Set only while `ownership_status`
+          #
           #   @param created_at [Time]
           #
           #   @param enterprise_id [String]
           #
+          #   @param flag_reason [String, nil] Why the number's ownership was flagged. `carrier_changed` when an ownership chec
+          #
+          #   @param ownership_status [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationOwnershipStatus] Result of ongoing ownership checks. `verified`: the number is with the carrier o
+          #
           #   @param phone_number [String] E.164 with leading `+`.
           #
-          #   @param reputation_data [Telnyx::Models::ReputationData, nil] `null` until the first refresh has been collected for this number.
+          #   @param removal_reason [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationPhoneNumber::RemovalReason, nil] Why a number was removed. `ported_away`: you confirmed the number left your cont
+          #
+          #   @param removed_at [Time, nil] When the number was removed. Set only for removed numbers.
+          #
+          #   @param reputation_data [Telnyx::Models::ReputationData, nil] Reputation snapshot for a phone number. Each metric is a 0–100 score; `spam_risk
+          #
+          #   @param source [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationNumberSource] Where the phone number is hosted. `telnyx`: in your Telnyx inventory. `external`
           #
           #   @param updated_at [Time]
+
+          # Why a number was removed. `ported_away`: you confirmed the number left your
+          # control after a carrier change. `unconfirmed_ownership`: a carrier change was
+          # not confirmed before the deadline. `reassigned`: the number was reported as
+          # permanently disconnected. `customer_reported`: you reported that you no longer
+          # own the number. `customer_removed`: you removed the number.
+          #
+          # @see Telnyx::Models::Enterprises::Reputation::ReputationPhoneNumber#removal_reason
+          module RemovalReason
+            extend Telnyx::Internal::Type::Enum
+
+            PORTED_AWAY = :ported_away
+            UNCONFIRMED_OWNERSHIP = :unconfirmed_ownership
+            REASSIGNED = :reassigned
+            CUSTOMER_REPORTED = :customer_reported
+            CUSTOMER_REMOVED = :customer_removed
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
       end
 

data/lib/telnyx/models/enterprises/reputation_update_webhook_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      # @see Telnyx::Resources::Enterprises::Reputation#update_webhook
+      class ReputationUpdateWebhookParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute enterprise_id
+        #
+        #   @return [String]
+        required :enterprise_id, String
+
+        # @!attribute webhook_url
+        #   HTTPS URL on a publicly routable host. Send `null` to stop receiving
+        #   number-ownership events.
+        #
+        #   @return [String, nil]
+        required :webhook_url, String, nil?: true
+
+        # @!method initialize(enterprise_id:, webhook_url:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Enterprises::ReputationUpdateWebhookParams} for more details.
+        #
+        #   @param enterprise_id [String]
+        #
+        #   @param webhook_url [String, nil] HTTPS URL on a publicly routable host. Send `null` to stop receiving number-owne
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/enterprises/verify_email_confirm_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      # @see Telnyx::Resources::Enterprises::VerifyEmail#confirm
+      class VerifyEmailConfirmParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute enterprise_id
+        #
+        #   @return [String]
+        required :enterprise_id, String
+
+        # @!attribute code
+        #   The 6-digit code sent to the enterprise account's contact email.
+        #
+        #   @return [String]
+        required :code, String
+
+        # @!method initialize(enterprise_id:, code:, request_options: {})
+        #   @param enterprise_id [String]
+        #
+        #   @param code [String] The 6-digit code sent to the enterprise account's contact email.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/enterprises/verify_email_create_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      # @see Telnyx::Resources::Enterprises::VerifyEmail#create
+      class VerifyEmailCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute enterprise_id
+        #
+        #   @return [String]
+        required :enterprise_id, String
+
+        # @!method initialize(enterprise_id:, request_options: {})
+        #   @param enterprise_id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/infringement_claim.rb

@@ -208,6 +208,10 @@ module Telnyx
         #   - `infringement_claimed` - a trademark/impersonation claim is open against this
         #     DIR.
         #   - `permanently_rejected` - terminal; cannot be resubmitted.
+        #   - `delete_requested` - you have requested deletion; the DIR still exists and
+        #     Telnyx is completing the removal (de-registration and cleanup). A verified DIR
+        #     keeps serving its branded identity, and keeps billing, until the removal
+        #     finishes.
         #
         #   @return [Symbol, Telnyx::Models::DirStatus, nil]
         optional :status, enum: -> { Telnyx::DirStatus }

data/lib/telnyx/models/llm_token_gateway/ai_gateway_resources_page_meta.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      class AIGatewayResourcesPageMeta < Telnyx::Internal::Type::BaseModel
+        # @!attribute has_more
+        #
+        #   @return [Boolean]
+        required :has_more, Telnyx::Internal::Type::Boolean
+
+        # @!attribute page_number
+        #
+        #   @return [Integer]
+        required :page_number, Integer
+
+        # @!attribute page_size
+        #
+        #   @return [Integer]
+        required :page_size, Integer
+
+        # @!attribute snapshot
+        #
+        #   @return [String]
+        required :snapshot, String
+
+        # @!method initialize(has_more:, page_number:, page_size:, snapshot:)
+        #   @param has_more [Boolean]
+        #   @param page_number [Integer]
+        #   @param page_size [Integer]
+        #   @param snapshot [String]
+      end
+    end
+  end
+end

data/lib/telnyx/models/llm_token_gateway/budget_duration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      module BudgetDuration
+        extend Telnyx::Internal::Type::Enum
+
+        BUDGET_DURATION_1D = :"1d"
+        BUDGET_DURATION_7D = :"7d"
+        BUDGET_DURATION_30D = :"30d"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/llm_token_gateway/guardrail_finding.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      class GuardrailFinding < Telnyx::Internal::Type::BaseModel
+        # @!attribute action
+        #
+        #   @return [Symbol, Telnyx::Models::LlmTokenGateway::GuardrailFinding::Action]
+        required :action, enum: -> { Telnyx::LlmTokenGateway::GuardrailFinding::Action }
+
+        # @!attribute code
+        #
+        #   @return [String]
+        required :code, String
+
+        # @!attribute count
+        #
+        #   @return [Integer]
+        required :count, Integer
+
+        # @!attribute detector
+        #
+        #   @return [Symbol, Telnyx::Models::LlmTokenGateway::GuardrailFinding::Detector]
+        required :detector, enum: -> { Telnyx::LlmTokenGateway::GuardrailFinding::Detector }
+
+        # @!method initialize(action:, code:, count:, detector:)
+        #   @param action [Symbol, Telnyx::Models::LlmTokenGateway::GuardrailFinding::Action]
+        #   @param code [String]
+        #   @param count [Integer]
+        #   @param detector [Symbol, Telnyx::Models::LlmTokenGateway::GuardrailFinding::Detector]
+
+        # @see Telnyx::Models::LlmTokenGateway::GuardrailFinding#action
+        module Action
+          extend Telnyx::Internal::Type::Enum
+
+          FLAG = :flag
+          BLOCK = :block
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Telnyx::Models::LlmTokenGateway::GuardrailFinding#detector
+        module Detector
+          extend Telnyx::Internal::Type::Enum
+
+          SECRETS = :secrets
+          DLP = :dlp
+          SAFETY = :safety
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/llm_token_gateway/spend_group_by.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      # Group by one request tag key. Keys starting with ltg*, telnyx*, litellm* or cf*
+      # (any case) are rejected.
+      module SpendGroupBy
+        extend Telnyx::Internal::Type::Union
+
+        variant const: -> { Telnyx::Models::LlmTokenGateway::SpendGroupBy::TOKEN_GROUP }
+
+        variant const: -> { Telnyx::Models::LlmTokenGateway::SpendGroupBy::TOKEN_USER }
+
+        variant const: -> { Telnyx::Models::LlmTokenGateway::SpendGroupBy::TOKEN_KEY }
+
+        variant const: -> { Telnyx::Models::LlmTokenGateway::SpendGroupBy::END_USER }
+
+        # Group by one request tag key. Keys starting with ltg_, telnyx_, litellm_ or cf_ (any case) are rejected.
+        variant String
+
+        # @!method self.variants
+        #   @return [Array(Symbol, String)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias { T.any(Telnyx::LlmTokenGateway::SpendGroupBy::TaggedSymbol, String) }
+        end
+
+        # @!group
+
+        TOKEN_GROUP = :token_group
+        TOKEN_USER = :token_user
+        TOKEN_KEY = :token_key
+        END_USER = :end_user
+
+        # @!endgroup
+      end
+    end
+  end
+end