telnyx 5.65.0 → 5.66.1

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      # @see Telnyx::Resources::Enterprises::Reputation#update_frequency
+      class ReputationUpdateFrequencyParams < 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 check_frequency
+        #   New frequency for refreshing reputation data
+        #
+        #   @return [Symbol, Telnyx::Models::Enterprises::ReputationUpdateFrequencyParams::CheckFrequency]
+        required :check_frequency,
+                 enum: -> { Telnyx::Enterprises::ReputationUpdateFrequencyParams::CheckFrequency }
+
+        # @!method initialize(enterprise_id:, check_frequency:, request_options: {})
+        #   @param enterprise_id [String]
+        #
+        #   @param check_frequency [Symbol, Telnyx::Models::Enterprises::ReputationUpdateFrequencyParams::CheckFrequency] New frequency for refreshing reputation data
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        # New frequency for refreshing reputation data
+        module CheckFrequency
+          extend Telnyx::Internal::Type::Enum
+
+          BUSINESS_DAILY = :business_daily
+          DAILY = :daily
+          WEEKLY = :weekly
+          BIWEEKLY = :biweekly
+          MONTHLY = :monthly
+          NEVER = :never
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Enterprises
+      # @see Telnyx::Resources::Enterprises::Reputation#update_frequency
+      class ReputationUpdateFrequencyResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse::Data, nil]
+        optional :data, -> { Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse::Data }
+
+        # @!method initialize(data: nil)
+        #   @param data [Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse::Data]
+
+        # @see Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute check_frequency
+          #   Frequency for refreshing reputation data
+          #
+          #   @return [Symbol, Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse::Data::CheckFrequency, nil]
+          optional :check_frequency,
+                   enum: -> { Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse::Data::CheckFrequency }
+
+          # @!attribute created_at
+          #   When the reputation settings were created
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute enterprise_id
+          #   ID of the associated enterprise
+          #
+          #   @return [String, nil]
+          optional :enterprise_id, String
+
+          # @!attribute loa_document_id
+          #   ID of the signed LOA document
+          #
+          #   @return [String, nil]
+          optional :loa_document_id, String, nil?: true
+
+          # @!attribute rejection_reasons
+          #   Reasons for rejection (present when status is rejected)
+          #
+          #   @return [Array<String>, nil]
+          optional :rejection_reasons, Telnyx::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute status
+          #   Current enrollment status
+          #
+          #   @return [Symbol, Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse::Data::Status, nil]
+          optional :status,
+                   enum: -> { Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse::Data::Status }
+
+          # @!attribute updated_at
+          #   When the reputation settings were last updated
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time
+
+          # @!method initialize(check_frequency: nil, created_at: nil, enterprise_id: nil, loa_document_id: nil, rejection_reasons: nil, status: nil, updated_at: nil)
+          #   @param check_frequency [Symbol, Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse::Data::CheckFrequency] Frequency for refreshing reputation data
+          #
+          #   @param created_at [Time] When the reputation settings were created
+          #
+          #   @param enterprise_id [String] ID of the associated enterprise
+          #
+          #   @param loa_document_id [String, nil] ID of the signed LOA document
+          #
+          #   @param rejection_reasons [Array<String>, nil] Reasons for rejection (present when status is rejected)
+          #
+          #   @param status [Symbol, Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse::Data::Status] Current enrollment status
+          #
+          #   @param updated_at [Time] When the reputation settings were last updated
+
+          # Frequency for refreshing reputation data
+          #
+          # @see Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse::Data#check_frequency
+          module CheckFrequency
+            extend Telnyx::Internal::Type::Enum
+
+            BUSINESS_DAILY = :business_daily
+            DAILY = :daily
+            WEEKLY = :weekly
+            BIWEEKLY = :biweekly
+            MONTHLY = :monthly
+            NEVER = :never
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Current enrollment status
+          #
+          # @see Telnyx::Models::Enterprises::ReputationUpdateFrequencyResponse::Data#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            PENDING = :pending
+            APPROVED = :approved
+            REJECTED = :rejected
+            DELETED = :deleted
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/reputation/number_delete_params.rb

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

data/lib/telnyx/models/reputation/number_list_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Reputation
+      # @see Telnyx::Resources::Reputation::Numbers#list
+      class NumberListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute page_number
+        #   Page number (1-indexed)
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #   Number of items per page
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!attribute phone_number
+        #   Filter by specific phone number (E.164 format)
+        #
+        #   @return [String, nil]
+        optional :phone_number, String
+
+        # @!method initialize(page_number: nil, page_size: nil, phone_number: nil, request_options: {})
+        #   @param page_number [Integer] Page number (1-indexed)
+        #
+        #   @param page_size [Integer] Number of items per page
+        #
+        #   @param phone_number [String] Filter by specific phone number (E.164 format)
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/reputation/number_list_response.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Reputation
+      # @see Telnyx::Resources::Reputation::Numbers#list
+      class NumberListResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #   When the number was associated
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute enterprise_id
+        #   ID of the associated enterprise
+        #
+        #   @return [String, nil]
+        optional :enterprise_id, String
+
+        # @!attribute phone_number
+        #   Phone number in E.164 format
+        #
+        #   @return [String, nil]
+        optional :phone_number, String
+
+        # @!attribute reputation_data
+        #   Reputation metrics (null if not yet fetched)
+        #
+        #   @return [Telnyx::Models::Reputation::NumberListResponse::ReputationData::ReputationData, Object, nil]
+        optional :reputation_data, union: -> { Telnyx::Models::Reputation::NumberListResponse::ReputationData }
+
+        # @!attribute updated_at
+        #   When the record was last updated
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+
+        # @!method initialize(id: nil, created_at: nil, enterprise_id: nil, phone_number: nil, reputation_data: nil, updated_at: nil)
+        #   @param id [String] Unique identifier
+        #
+        #   @param created_at [Time] When the number was associated
+        #
+        #   @param enterprise_id [String] ID of the associated enterprise
+        #
+        #   @param phone_number [String] Phone number in E.164 format
+        #
+        #   @param reputation_data [Telnyx::Models::Reputation::NumberListResponse::ReputationData::ReputationData, Object, nil] Reputation metrics (null if not yet fetched)
+        #
+        #   @param updated_at [Time] When the record was last updated
+
+        # Reputation metrics (null if not yet fetched)
+        #
+        # @see Telnyx::Models::Reputation::NumberListResponse#reputation_data
+        module ReputationData
+          extend Telnyx::Internal::Type::Union
+
+          # Reputation metrics
+          variant -> { Telnyx::Models::Reputation::NumberListResponse::ReputationData::ReputationData }
+
+          variant Telnyx::Internal::Type::Unknown
+
+          class ReputationData < Telnyx::Internal::Type::BaseModel
+            # @!attribute connection_score
+            #   Connection quality metric (0–100)
+            #
+            #   @return [Integer, nil]
+            optional :connection_score, Integer, nil?: true
+
+            # @!attribute engagement_score
+            #   Engagement metric (0–100). Higher = more positive engagement
+            #
+            #   @return [Integer, nil]
+            optional :engagement_score, Integer, nil?: true
+
+            # @!attribute last_refreshed_at
+            #   Timestamp of the last reputation data refresh
+            #
+            #   @return [Time, nil]
+            optional :last_refreshed_at, Time, nil?: true
+
+            # @!attribute maturity_score
+            #   Maturity metric (0–100). Higher = more established number
+            #
+            #   @return [Integer, nil]
+            optional :maturity_score, Integer, nil?: true
+
+            # @!attribute sentiment_score
+            #   Sentiment metric (0–100). Higher = more positive sentiment
+            #
+            #   @return [Integer, nil]
+            optional :sentiment_score, Integer, nil?: true
+
+            # @!attribute spam_category
+            #   Spam category classification (e.g., Telemarketing, Debt Collector)
+            #
+            #   @return [String, nil]
+            optional :spam_category, String, nil?: true
+
+            # @!attribute spam_risk
+            #   Overall spam risk level
+            #
+            #   @return [Symbol, Telnyx::Models::Reputation::NumberListResponse::ReputationData::ReputationData::SpamRisk, nil]
+            optional :spam_risk,
+                     enum: -> { Telnyx::Models::Reputation::NumberListResponse::ReputationData::ReputationData::SpamRisk },
+                     nil?: true
+
+            # @!method initialize(connection_score: nil, engagement_score: nil, last_refreshed_at: nil, maturity_score: nil, sentiment_score: nil, spam_category: nil, spam_risk: nil)
+            #   Reputation metrics
+            #
+            #   @param connection_score [Integer, nil] Connection quality metric (0–100)
+            #
+            #   @param engagement_score [Integer, nil] Engagement metric (0–100). Higher = more positive engagement
+            #
+            #   @param last_refreshed_at [Time, nil] Timestamp of the last reputation data refresh
+            #
+            #   @param maturity_score [Integer, nil] Maturity metric (0–100). Higher = more established number
+            #
+            #   @param sentiment_score [Integer, nil] Sentiment metric (0–100). Higher = more positive sentiment
+            #
+            #   @param spam_category [String, nil] Spam category classification (e.g., Telemarketing, Debt Collector)
+            #
+            #   @param spam_risk [Symbol, Telnyx::Models::Reputation::NumberListResponse::ReputationData::ReputationData::SpamRisk, nil] Overall spam risk level
+
+            # Overall spam risk level
+            #
+            # @see Telnyx::Models::Reputation::NumberListResponse::ReputationData::ReputationData#spam_risk
+            module SpamRisk
+              extend Telnyx::Internal::Type::Enum
+
+              LOW = :low
+              MEDIUM = :medium
+              HIGH = :high
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(Telnyx::Models::Reputation::NumberListResponse::ReputationData::ReputationData, Object)]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/reputation/number_retrieve_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Reputation
+      # @see Telnyx::Resources::Reputation::Numbers#retrieve
+      class NumberRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute phone_number
+        #
+        #   @return [String]
+        required :phone_number, String
+
+        # @!attribute fresh
+        #   When true, fetches fresh reputation data (incurs API cost). When false, returns
+        #   cached data.
+        #
+        #   @return [Boolean, nil]
+        optional :fresh, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(phone_number:, fresh: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Reputation::NumberRetrieveParams} for more details.
+        #
+        #   @param phone_number [String]
+        #
+        #   @param fresh [Boolean] When true, fetches fresh reputation data (incurs API cost). When false, returns
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/reputation/number_retrieve_response.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Reputation
+      # @see Telnyx::Resources::Reputation::Numbers#retrieve
+      class NumberRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::Reputation::NumberRetrieveResponse::Data, nil]
+        optional :data, -> { Telnyx::Models::Reputation::NumberRetrieveResponse::Data }
+
+        # @!method initialize(data: nil)
+        #   @param data [Telnyx::Models::Reputation::NumberRetrieveResponse::Data]
+
+        # @see Telnyx::Models::Reputation::NumberRetrieveResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #   Unique identifier
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute created_at
+          #   When the number was associated
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute enterprise_id
+          #   ID of the associated enterprise
+          #
+          #   @return [String, nil]
+          optional :enterprise_id, String
+
+          # @!attribute phone_number
+          #   Phone number in E.164 format
+          #
+          #   @return [String, nil]
+          optional :phone_number, String
+
+          # @!attribute reputation_data
+          #   Reputation metrics (null if not yet fetched)
+          #
+          #   @return [Telnyx::Models::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData, Object, nil]
+          optional :reputation_data,
+                   union: -> { Telnyx::Models::Reputation::NumberRetrieveResponse::Data::ReputationData }
+
+          # @!attribute updated_at
+          #   When the record was last updated
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time
+
+          # @!method initialize(id: nil, created_at: nil, enterprise_id: nil, phone_number: nil, reputation_data: nil, updated_at: nil)
+          #   @param id [String] Unique identifier
+          #
+          #   @param created_at [Time] When the number was associated
+          #
+          #   @param enterprise_id [String] ID of the associated enterprise
+          #
+          #   @param phone_number [String] Phone number in E.164 format
+          #
+          #   @param reputation_data [Telnyx::Models::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData, Object, nil] Reputation metrics (null if not yet fetched)
+          #
+          #   @param updated_at [Time] When the record was last updated
+
+          # Reputation metrics (null if not yet fetched)
+          #
+          # @see Telnyx::Models::Reputation::NumberRetrieveResponse::Data#reputation_data
+          module ReputationData
+            extend Telnyx::Internal::Type::Union
+
+            # Reputation metrics
+            variant -> { Telnyx::Models::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData }
+
+            variant Telnyx::Internal::Type::Unknown
+
+            class ReputationData < Telnyx::Internal::Type::BaseModel
+              # @!attribute connection_score
+              #   Connection quality metric (0–100)
+              #
+              #   @return [Integer, nil]
+              optional :connection_score, Integer, nil?: true
+
+              # @!attribute engagement_score
+              #   Engagement metric (0–100). Higher = more positive engagement
+              #
+              #   @return [Integer, nil]
+              optional :engagement_score, Integer, nil?: true
+
+              # @!attribute last_refreshed_at
+              #   Timestamp of the last reputation data refresh
+              #
+              #   @return [Time, nil]
+              optional :last_refreshed_at, Time, nil?: true
+
+              # @!attribute maturity_score
+              #   Maturity metric (0–100). Higher = more established number
+              #
+              #   @return [Integer, nil]
+              optional :maturity_score, Integer, nil?: true
+
+              # @!attribute sentiment_score
+              #   Sentiment metric (0–100). Higher = more positive sentiment
+              #
+              #   @return [Integer, nil]
+              optional :sentiment_score, Integer, nil?: true
+
+              # @!attribute spam_category
+              #   Spam category classification (e.g., Telemarketing, Debt Collector)
+              #
+              #   @return [String, nil]
+              optional :spam_category, String, nil?: true
+
+              # @!attribute spam_risk
+              #   Overall spam risk level
+              #
+              #   @return [Symbol, Telnyx::Models::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData::SpamRisk, nil]
+              optional :spam_risk,
+                       enum: -> { Telnyx::Models::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData::SpamRisk },
+                       nil?: true
+
+              # @!method initialize(connection_score: nil, engagement_score: nil, last_refreshed_at: nil, maturity_score: nil, sentiment_score: nil, spam_category: nil, spam_risk: nil)
+              #   Reputation metrics
+              #
+              #   @param connection_score [Integer, nil] Connection quality metric (0–100)
+              #
+              #   @param engagement_score [Integer, nil] Engagement metric (0–100). Higher = more positive engagement
+              #
+              #   @param last_refreshed_at [Time, nil] Timestamp of the last reputation data refresh
+              #
+              #   @param maturity_score [Integer, nil] Maturity metric (0–100). Higher = more established number
+              #
+              #   @param sentiment_score [Integer, nil] Sentiment metric (0–100). Higher = more positive sentiment
+              #
+              #   @param spam_category [String, nil] Spam category classification (e.g., Telemarketing, Debt Collector)
+              #
+              #   @param spam_risk [Symbol, Telnyx::Models::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData::SpamRisk, nil] Overall spam risk level
+
+              # Overall spam risk level
+              #
+              # @see Telnyx::Models::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData#spam_risk
+              module SpamRisk
+                extend Telnyx::Internal::Type::Enum
+
+                LOW = :low
+                MEDIUM = :medium
+                HIGH = :high
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            # @!method self.variants
+            #   @return [Array(Telnyx::Models::Reputation::NumberRetrieveResponse::Data::ReputationData::ReputationData, Object)]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/terms_of_service/number_reputation_agree_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module TermsOfService
+      # @see Telnyx::Resources::TermsOfService::NumberReputation#agree
+      class NumberReputationAgreeParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models.rb

@@ -546,6 +546,18 @@ module Telnyx
 
   EncryptedMedia = Telnyx::Models::EncryptedMedia
 
+  EnterpriseCreateParams = Telnyx::Models::EnterpriseCreateParams
+
+  EnterpriseDeleteParams = Telnyx::Models::EnterpriseDeleteParams
+
+  EnterpriseListParams = Telnyx::Models::EnterpriseListParams
+
+  EnterpriseRetrieveParams = Telnyx::Models::EnterpriseRetrieveParams
+
+  Enterprises = Telnyx::Models::Enterprises
+
+  EnterpriseUpdateParams = Telnyx::Models::EnterpriseUpdateParams
+
   EventNode = Telnyx::Models::EventNode
 
   ExternalConnection = Telnyx::Models::ExternalConnection
@@ -1293,6 +1305,8 @@ module Telnyx
 
   Reports = Telnyx::Models::Reports
 
+  Reputation = Telnyx::Models::Reputation
+
   RequirementGroup = Telnyx::Models::RequirementGroup
 
   RequirementGroupCreateParams = Telnyx::Models::RequirementGroupCreateParams
@@ -1508,6 +1522,8 @@ module Telnyx
 
   TelephonyCredentialUpdateParams = Telnyx::Models::TelephonyCredentialUpdateParams
 
+  TermsOfService = Telnyx::Models::TermsOfService
+
   Texml = Telnyx::Models::Texml
 
   TexmlApplication = Telnyx::Models::TexmlApplication