telnyx 5.159.0 → 5.160.0

data/lib/telnyx/models/numbers_phone_number_detailed.rb

@@ -0,0 +1,369 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::PhoneNumbers#list
+    class NumbersPhoneNumberDetailed < Telnyx::Internal::Type::BaseModel
+      # @!attribute deletion_lock_enabled
+      #   Indicates whether deletion lock is enabled for this number. When enabled, this
+      #   prevents the phone number from being deleted via the API or Telnyx portal.
+      #
+      #   @return [Boolean]
+      required :deletion_lock_enabled, Telnyx::Internal::Type::Boolean
+
+      # @!attribute external_pin
+      #   If someone attempts to port your phone number away from Telnyx and your phone
+      #   number has an external PIN set, Telnyx will attempt to verify that you provided
+      #   the correct external PIN to the winning carrier. Note that not all carriers
+      #   cooperate with this security mechanism.
+      #
+      #   @return [String, nil]
+      required :external_pin, String, nil?: true
+
+      # @!attribute tags
+      #   A list of user-assigned tags to help manage the phone number.
+      #
+      #   @return [Array<String>]
+      required :tags, Telnyx::Internal::Type::ArrayOf[String]
+
+      # @!attribute billing_group_id
+      #   Identifies the billing group associated with the phone number.
+      #
+      #   @return [String, nil]
+      optional :billing_group_id, String, nil?: true
+
+      # @!attribute connection_id
+      #   Identifies the connection associated with the phone number.
+      #
+      #   @return [String, nil]
+      optional :connection_id, String, nil?: true
+
+      # @!attribute customer_reference
+      #   A customer reference string for customer look ups.
+      #
+      #   @return [String, nil]
+      optional :customer_reference, String, nil?: true
+
+      # @!attribute emergency_status
+      #   Indicates the status of the provisioning of emergency services for the phone
+      #   number. This field contains information about activity that may be ongoing for a
+      #   number where it either is being provisioned or deprovisioned but is not yet
+      #   enabled/disabled.
+      #
+      #   @return [Symbol, Telnyx::Models::NumbersPhoneNumberDetailed::EmergencyStatus, nil]
+      optional :emergency_status, enum: -> { Telnyx::NumbersPhoneNumberDetailed::EmergencyStatus }
+
+      # @!attribute inbound_call_screening
+      #   The inbound_call_screening setting is a phone number configuration option
+      #   variable that allows users to configure their settings to block or flag
+      #   fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This
+      #   feature has an additional per-number monthly cost associated with it.
+      #
+      #   @return [Symbol, Telnyx::Models::NumbersPhoneNumberDetailed::InboundCallScreening, nil]
+      optional :inbound_call_screening, enum: -> { Telnyx::NumbersPhoneNumberDetailed::InboundCallScreening }
+
+      # @!attribute messaging_profile_id
+      #   Identifies the messaging profile associated with the phone number.
+      #
+      #   @return [String, nil]
+      optional :messaging_profile_id, String, nil?: true
+
+      # @!attribute messaging_profile_name
+      #   The name of the messaging profile associated with the phone number.
+      #
+      #   @return [String, nil]
+      optional :messaging_profile_name, String, nil?: true
+
+      response_only do
+        # @!attribute id
+        #   Identifies the resource.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute country_iso_alpha2
+        #   The ISO 3166-1 alpha-2 country code of the phone number.
+        #
+        #   @return [String]
+        required :country_iso_alpha2, String
+
+        # @!attribute created_at
+        #   ISO 8601 formatted date indicating when the resource was created.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute phone_number
+        #   The +E.164-formatted phone number associated with this record.
+        #
+        #   @return [String]
+        required :phone_number, String
+
+        # @!attribute phone_number_type
+        #   The phone number's type. Note: For numbers purchased prior to July 2023 or when
+        #   fetching a number's details immediately after a purchase completes, the legacy
+        #   values `tollfree`, `shortcode` or `longcode` may be returned instead.
+        #
+        #   @return [Symbol, Telnyx::Models::NumbersPhoneNumberDetailed::PhoneNumberType]
+        required :phone_number_type, enum: -> { Telnyx::NumbersPhoneNumberDetailed::PhoneNumberType }
+
+        # @!attribute purchased_at
+        #   ISO 8601 formatted date indicating when the resource was purchased.
+        #
+        #   @return [String]
+        required :purchased_at, String
+
+        # @!attribute record_type
+        #   Identifies the type of the resource.
+        #
+        #   @return [String]
+        required :record_type, String
+
+        # @!attribute status
+        #   The phone number's current status.
+        #
+        #   @return [Symbol, Telnyx::Models::NumbersPhoneNumberDetailed::Status]
+        required :status, enum: -> { Telnyx::NumbersPhoneNumberDetailed::Status }
+
+        # @!attribute activated_at
+        #   ISO 8601 formatted date indicating when the phone number was first activated
+        #   (transitioned from purchase-pending or port-pending to active). Will be null for
+        #   numbers that have not yet been activated, or for legacy numbers activated before
+        #   this field was tracked.
+        #
+        #   @return [Time, nil]
+        optional :activated_at, Time, nil?: true
+
+        # @!attribute call_forwarding_enabled
+        #   Indicates if call forwarding will be enabled for this number if forwards_to and
+        #   forwarding_type are filled in. Defaults to true for backwards compatibility with
+        #   APIV1 use of numbers endpoints.
+        #
+        #   @return [Boolean, nil]
+        optional :call_forwarding_enabled, Telnyx::Internal::Type::Boolean
+
+        # @!attribute call_recording_enabled
+        #   Indicates whether call recording is enabled for this number.
+        #
+        #   @return [Boolean, nil]
+        optional :call_recording_enabled, Telnyx::Internal::Type::Boolean
+
+        # @!attribute caller_id_name_enabled
+        #   Indicates whether caller ID is enabled for this number.
+        #
+        #   @return [Boolean, nil]
+        optional :caller_id_name_enabled, Telnyx::Internal::Type::Boolean
+
+        # @!attribute cnam_listing_enabled
+        #   Indicates whether a CNAM listing is enabled for this number.
+        #
+        #   @return [Boolean, nil]
+        optional :cnam_listing_enabled, Telnyx::Internal::Type::Boolean
+
+        # @!attribute connection_name
+        #   The user-assigned name of the connection to be associated with this phone
+        #   number.
+        #
+        #   @return [String, nil]
+        optional :connection_name, String, nil?: true
+
+        # @!attribute emergency_address_id
+        #   Identifies the emergency address associated with the phone number.
+        #
+        #   @return [String, nil]
+        optional :emergency_address_id, String, nil?: true
+
+        # @!attribute emergency_enabled
+        #   Indicates whether emergency services are enabled for this number.
+        #
+        #   @return [Boolean, nil]
+        optional :emergency_enabled, Telnyx::Internal::Type::Boolean
+
+        # @!attribute hd_voice_enabled
+        #   Indicates whether HD voice is enabled for this number.
+        #
+        #   @return [Boolean, nil]
+        optional :hd_voice_enabled, Telnyx::Internal::Type::Boolean
+
+        # @!attribute source_type
+        #   Indicates if the phone number was purchased or ported in. For some numbers this
+        #   information may not be available.
+        #
+        #   @return [Symbol, Telnyx::Models::NumbersPhoneNumberDetailed::SourceType, nil]
+        optional :source_type, enum: -> { Telnyx::NumbersPhoneNumberDetailed::SourceType }, nil?: true
+
+        # @!attribute t38_fax_gateway_enabled
+        #   Indicates whether T38 Fax Gateway for inbound calls to this number.
+        #
+        #   @return [Boolean, nil]
+        optional :t38_fax_gateway_enabled, Telnyx::Internal::Type::Boolean
+
+        # @!attribute updated_at
+        #   ISO 8601 formatted date indicating when the resource was updated.
+        #
+        #   @return [String, nil]
+        optional :updated_at, String
+      end
+
+      # @!method initialize(id:, country_iso_alpha2:, created_at:, deletion_lock_enabled:, external_pin:, phone_number:, phone_number_type:, purchased_at:, record_type:, status:, tags:, activated_at: nil, billing_group_id: nil, call_forwarding_enabled: nil, call_recording_enabled: nil, caller_id_name_enabled: nil, cnam_listing_enabled: nil, connection_id: nil, connection_name: nil, customer_reference: nil, emergency_address_id: nil, emergency_enabled: nil, emergency_status: nil, hd_voice_enabled: nil, inbound_call_screening: nil, messaging_profile_id: nil, messaging_profile_name: nil, source_type: nil, t38_fax_gateway_enabled: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::NumbersPhoneNumberDetailed} for more details.
+      #
+      #   @param id [String] Identifies the resource.
+      #
+      #   @param country_iso_alpha2 [String] The ISO 3166-1 alpha-2 country code of the phone number.
+      #
+      #   @param created_at [Time] ISO 8601 formatted date indicating when the resource was created.
+      #
+      #   @param deletion_lock_enabled [Boolean] Indicates whether deletion lock is enabled for this number. When enabled, this p
+      #
+      #   @param external_pin [String, nil] If someone attempts to port your phone number away from Telnyx and your phone nu
+      #
+      #   @param phone_number [String] The +E.164-formatted phone number associated with this record.
+      #
+      #   @param phone_number_type [Symbol, Telnyx::Models::NumbersPhoneNumberDetailed::PhoneNumberType] The phone number's type.
+      #
+      #   @param purchased_at [String] ISO 8601 formatted date indicating when the resource was purchased.
+      #
+      #   @param record_type [String] Identifies the type of the resource.
+      #
+      #   @param status [Symbol, Telnyx::Models::NumbersPhoneNumberDetailed::Status] The phone number's current status.
+      #
+      #   @param tags [Array<String>] A list of user-assigned tags to help manage the phone number.
+      #
+      #   @param activated_at [Time, nil] ISO 8601 formatted date indicating when the phone number was first activated (tr
+      #
+      #   @param billing_group_id [String, nil] Identifies the billing group associated with the phone number.
+      #
+      #   @param call_forwarding_enabled [Boolean] Indicates if call forwarding will be enabled for this number if forwards_to and
+      #
+      #   @param call_recording_enabled [Boolean] Indicates whether call recording is enabled for this number.
+      #
+      #   @param caller_id_name_enabled [Boolean] Indicates whether caller ID is enabled for this number.
+      #
+      #   @param cnam_listing_enabled [Boolean] Indicates whether a CNAM listing is enabled for this number.
+      #
+      #   @param connection_id [String, nil] Identifies the connection associated with the phone number.
+      #
+      #   @param connection_name [String, nil] The user-assigned name of the connection to be associated with this phone number
+      #
+      #   @param customer_reference [String, nil] A customer reference string for customer look ups.
+      #
+      #   @param emergency_address_id [String, nil] Identifies the emergency address associated with the phone number.
+      #
+      #   @param emergency_enabled [Boolean] Indicates whether emergency services are enabled for this number.
+      #
+      #   @param emergency_status [Symbol, Telnyx::Models::NumbersPhoneNumberDetailed::EmergencyStatus] Indicates the status of the provisioning of emergency services for the phone num
+      #
+      #   @param hd_voice_enabled [Boolean] Indicates whether HD voice is enabled for this number.
+      #
+      #   @param inbound_call_screening [Symbol, Telnyx::Models::NumbersPhoneNumberDetailed::InboundCallScreening] The inbound_call_screening setting is a phone number configuration option variab
+      #
+      #   @param messaging_profile_id [String, nil] Identifies the messaging profile associated with the phone number.
+      #
+      #   @param messaging_profile_name [String, nil] The name of the messaging profile associated with the phone number.
+      #
+      #   @param source_type [Symbol, Telnyx::Models::NumbersPhoneNumberDetailed::SourceType, nil] Indicates if the phone number was purchased or ported in. For some numbers this
+      #
+      #   @param t38_fax_gateway_enabled [Boolean] Indicates whether T38 Fax Gateway for inbound calls to this number.
+      #
+      #   @param updated_at [String] ISO 8601 formatted date indicating when the resource was updated.
+
+      # The phone number's type. Note: For numbers purchased prior to July 2023 or when
+      # fetching a number's details immediately after a purchase completes, the legacy
+      # values `tollfree`, `shortcode` or `longcode` may be returned instead.
+      #
+      # @see Telnyx::Models::NumbersPhoneNumberDetailed#phone_number_type
+      module PhoneNumberType
+        extend Telnyx::Internal::Type::Enum
+
+        LOCAL = :local
+        TOLL_FREE = :toll_free
+        MOBILE = :mobile
+        NATIONAL = :national
+        SHARED_COST = :shared_cost
+        LANDLINE = :landline
+        TOLLFREE = :tollfree
+        SHORTCODE = :shortcode
+        LONGCODE = :longcode
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The phone number's current status.
+      #
+      # @see Telnyx::Models::NumbersPhoneNumberDetailed#status
+      module Status
+        extend Telnyx::Internal::Type::Enum
+
+        PURCHASE_PENDING = :"purchase-pending"
+        PURCHASE_FAILED = :"purchase-failed"
+        PORT_PENDING = :"port-pending"
+        PORT_FAILED = :"port-failed"
+        ACTIVE = :active
+        DELETED = :deleted
+        EMERGENCY_ONLY = :"emergency-only"
+        PORTED_OUT = :"ported-out"
+        PORT_OUT_PENDING = :"port-out-pending"
+        REQUIREMENT_INFO_PENDING = :"requirement-info-pending"
+        REQUIREMENT_INFO_UNDER_REVIEW = :"requirement-info-under-review"
+        REQUIREMENT_INFO_EXCEPTION = :"requirement-info-exception"
+        PROVISION_PENDING = :"provision-pending"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Indicates the status of the provisioning of emergency services for the phone
+      # number. This field contains information about activity that may be ongoing for a
+      # number where it either is being provisioned or deprovisioned but is not yet
+      # enabled/disabled.
+      #
+      # @see Telnyx::Models::NumbersPhoneNumberDetailed#emergency_status
+      module EmergencyStatus
+        extend Telnyx::Internal::Type::Enum
+
+        ACTIVE = :active
+        DEPROVISIONING = :deprovisioning
+        DISABLED = :disabled
+        PROVISIONING = :provisioning
+        PROVISIONING_FAILED = :"provisioning-failed"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The inbound_call_screening setting is a phone number configuration option
+      # variable that allows users to configure their settings to block or flag
+      # fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This
+      # feature has an additional per-number monthly cost associated with it.
+      #
+      # @see Telnyx::Models::NumbersPhoneNumberDetailed#inbound_call_screening
+      module InboundCallScreening
+        extend Telnyx::Internal::Type::Enum
+
+        DISABLED = :disabled
+        REJECT_CALLS = :reject_calls
+        FLAG_CALLS = :flag_calls
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Indicates if the phone number was purchased or ported in. For some numbers this
+      # information may not be available.
+      #
+      # @see Telnyx::Models::NumbersPhoneNumberDetailed#source_type
+      module SourceType
+        extend Telnyx::Internal::Type::Enum
+
+        NUMBER_ORDER = :number_order
+        PORT_REQUEST = :port_request
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/oauth_oauth_pagination_meta.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class OAuthOAuthPaginationMeta < Telnyx::Internal::Type::BaseModel
+      # @!attribute page_number
+      #   Current page number
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Number of items per page
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute total_pages
+      #   Total number of pages
+      #
+      #   @return [Integer, nil]
+      optional :total_pages, Integer
+
+      # @!attribute total_results
+      #   Total number of results
+      #
+      #   @return [Integer, nil]
+      optional :total_results, Integer
+
+      # @!method initialize(page_number: nil, page_size: nil, total_pages: nil, total_results: nil)
+      #   @param page_number [Integer] Current page number
+      #
+      #   @param page_size [Integer] Number of items per page
+      #
+      #   @param total_pages [Integer] Total number of pages
+      #
+      #   @param total_results [Integer] Total number of results
+    end
+  end
+end

data/lib/telnyx/models/phone_number_detailed.rb

@@ -2,7 +2,6 @@
 
 module Telnyx
   module Models
-    # @see Telnyx::Resources::PhoneNumbers#list
     class PhoneNumberDetailed < Telnyx::Internal::Type::BaseModel
       # @!attribute deletion_lock_enabled
       #   Indicates whether deletion lock is enabled for this number. When enabled, this

data/lib/telnyx/models/phone_number_retrieve_response.rb

@@ -6,11 +6,11 @@ module Telnyx
     class PhoneNumberRetrieveResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::PhoneNumberDetailed, nil]
-      optional :data, -> { Telnyx::PhoneNumberDetailed }
+      #   @return [Telnyx::Models::NumbersPhoneNumberDetailed, nil]
+      optional :data, -> { Telnyx::NumbersPhoneNumberDetailed }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::PhoneNumberDetailed]
+      #   @param data [Telnyx::Models::NumbersPhoneNumberDetailed]
     end
   end
 end

data/lib/telnyx/models/phone_number_update_response.rb

@@ -6,11 +6,11 @@ module Telnyx
     class PhoneNumberUpdateResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::PhoneNumberDetailed, nil]
-      optional :data, -> { Telnyx::PhoneNumberDetailed }
+      #   @return [Telnyx::Models::NumbersPhoneNumberDetailed, nil]
+      optional :data, -> { Telnyx::NumbersPhoneNumberDetailed }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::PhoneNumberDetailed]
+      #   @param data [Telnyx::Models::NumbersPhoneNumberDetailed]
     end
   end
 end

data/lib/telnyx/models/pricing/product_retrieve_params.rb

@@ -13,6 +13,11 @@ module Telnyx
         #   @return [String]
         required :slug, String
 
+        # @!attribute filter_country_iso
+        #
+        #   @return [String, nil]
+        optional :filter_country_iso, String, nil?: true
+
         # @!attribute page_number
         #   Page number (1-based).
         #
@@ -25,9 +30,11 @@ module Telnyx
         #   @return [Integer, nil]
         optional :page_size, Integer
 
-        # @!method initialize(slug:, page_number: nil, page_size: nil, request_options: {})
+        # @!method initialize(slug:, filter_country_iso: nil, page_number: nil, page_size: nil, request_options: {})
         #   @param slug [String]
         #
+        #   @param filter_country_iso [String, nil]
+        #
         #   @param page_number [Integer] Page number (1-based).
         #
         #   @param page_size [Integer] Number of items per page (max 100).

data/lib/telnyx/models/rcs/agent_campaign_configuration.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Rcs
+      class AgentCampaignConfiguration < Telnyx::Internal::Type::BaseModel
+        # @!attribute company_overview
+        #
+        #   @return [String]
+        required :company_overview, String
+
+        # @!attribute additional_information
+        #
+        #   @return [String, nil]
+        optional :additional_information, String, nil?: true
+
+        # @!attribute agent_overview
+        #
+        #   @return [String, nil]
+        optional :agent_overview, String, nil?: true
+
+        # @!attribute consent_settings
+        #
+        #   @return [Telnyx::Models::Rcs::AgentConsentConfiguration, nil]
+        optional :consent_settings, -> { Telnyx::Rcs::AgentConsentConfiguration }, nil?: true
+
+        # @!attribute interactions
+        #
+        #   @return [Array<Telnyx::Models::Rcs::AgentInteraction>, nil]
+        optional :interactions, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Rcs::AgentInteraction] }
+
+        # @!attribute message_examples
+        #
+        #   @return [Array<String>, nil]
+        optional :message_examples, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(company_overview:, additional_information: nil, agent_overview: nil, consent_settings: nil, interactions: nil, message_examples: nil)
+        #   @param company_overview [String]
+        #   @param additional_information [String, nil]
+        #   @param agent_overview [String, nil]
+        #   @param consent_settings [Telnyx::Models::Rcs::AgentConsentConfiguration, nil]
+        #   @param interactions [Array<Telnyx::Models::Rcs::AgentInteraction>]
+        #   @param message_examples [Array<String>]
+      end
+    end
+  end
+end