telnyx 5.170.0 → 5.171.0

data/lib/telnyx/models/physical_address.rb

@@ -10,6 +10,7 @@ module Telnyx
       required :administrative_area, String
 
       # @!attribute city
+      #   The city of your registered business address.
       #
       #   @return [String]
       required :city, String
@@ -21,32 +22,40 @@ module Telnyx
       required :country, String
 
       # @!attribute postal_code
+      #   The postal or ZIP code of your registered business address.
       #
       #   @return [String]
       required :postal_code, String
 
       # @!attribute street_address
+      #   The street address of your registered business, including the building number
+      #   and street name.
       #
       #   @return [String]
       required :street_address, String
 
       # @!attribute extended_address
+      #   An optional second address line, such as a suite, unit, or floor. Leave blank if
+      #   it does not apply.
       #
       #   @return [String, nil]
       optional :extended_address, String, nil?: true
 
       # @!method initialize(administrative_area:, city:, country:, postal_code:, street_address:, extended_address: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::PhysicalAddress} for more details.
+      #
       #   @param administrative_area [String] State or province code (e.g. `IL`, `ON`).
       #
-      #   @param city [String]
+      #   @param city [String] The city of your registered business address.
       #
       #   @param country [String] ISO 3166-1 alpha-2 code (currently `US` or `CA`).
       #
-      #   @param postal_code [String]
+      #   @param postal_code [String] The postal or ZIP code of your registered business address.
       #
-      #   @param street_address [String]
+      #   @param street_address [String] The street address of your registered business, including the building number an
       #
-      #   @param extended_address [String, nil]
+      #   @param extended_address [String, nil] An optional second address line, such as a suite, unit, or floor. Leave blank if
     end
   end
 end

data/lib/telnyx/models/porting_order.rb

@@ -236,7 +236,9 @@ module Telnyx
         LANDLINE = :landline
         LOCAL = :local
         MOBILE = :mobile
+        MULTIPURPOSE = :multipurpose
         NATIONAL = :national
+        OTHER = :other
         SHARED_COST = :shared_cost
         TOLL_FREE = :toll_free
 

data/lib/telnyx/models/porting_orders/porting_phone_number_block.rb

@@ -140,7 +140,9 @@ module Telnyx
           LANDLINE = :landline
           LOCAL = :local
           MOBILE = :mobile
+          MULTIPURPOSE = :multipurpose
           NATIONAL = :national
+          OTHER = :other
           SHARED_COST = :shared_cost
           TOLL_FREE = :toll_free
 

data/lib/telnyx/models/porting_phone_number.rb

@@ -92,7 +92,9 @@ module Telnyx
         LANDLINE = :landline
         LOCAL = :local
         MOBILE = :mobile
+        MULTIPURPOSE = :multipurpose
         NATIONAL = :national
+        OTHER = :other
         SHARED_COST = :shared_cost
         TOLL_FREE = :toll_free
 

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

@@ -14,6 +14,14 @@ module Telnyx
         #   @return [String, nil]
         optional :filter_enterprise_id, String
 
+        # @!attribute filter_ownership_status
+        #   Only numbers with this ownership status. `removed` lists the numbers that were
+        #   removed, each with its `removal_reason` and `removed_at`; removed numbers are
+        #   not returned otherwise.
+        #
+        #   @return [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationOwnershipStatus, nil]
+        optional :filter_ownership_status, enum: -> { Telnyx::Enterprises::Reputation::ReputationOwnershipStatus }
+
         # @!attribute filter_phone_number_contains
         #   Partial match on phone number. Must contain at least 5 digits.
         #
@@ -26,6 +34,12 @@ module Telnyx
         #   @return [String, nil]
         optional :filter_phone_number_eq, String
 
+        # @!attribute filter_source
+        #   Only numbers with this source.
+        #
+        #   @return [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationNumberSource, nil]
+        optional :filter_source, enum: -> { Telnyx::Enterprises::Reputation::ReputationNumberSource }
+
         # @!attribute page_number
         #   1-based page number. Out-of-range values return an empty page with correct meta.
         #
@@ -38,16 +52,20 @@ module Telnyx
         #   @return [Integer, nil]
         optional :page_size, Integer
 
-        # @!method initialize(filter_enterprise_id: nil, filter_phone_number_contains: nil, filter_phone_number_eq: nil, page_number: nil, page_size: nil, request_options: {})
+        # @!method initialize(filter_enterprise_id: nil, filter_ownership_status: nil, filter_phone_number_contains: nil, filter_phone_number_eq: nil, filter_source: nil, page_number: nil, page_size: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::Reputation::NumberListParams} for more details.
         #
         #   @param filter_enterprise_id [String] Filter by enterprise ID.
         #
+        #   @param filter_ownership_status [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationOwnershipStatus] Only numbers with this ownership status. `removed` lists the numbers that were r
+        #
         #   @param filter_phone_number_contains [String] Partial match on phone number. Must contain at least 5 digits.
         #
         #   @param filter_phone_number_eq [String] Exact phone-number match (E.164).
         #
+        #   @param filter_source [Symbol, Telnyx::Models::Enterprises::Reputation::ReputationNumberSource] Only numbers with this source.
+        #
         #   @param page_number [Integer] 1-based page number. Out-of-range values return an empty page with correct meta.
         #
         #   @param page_size [Integer] Items per page. Maximum 250; values above are clamped to 250.

data/lib/telnyx/models/requirement_list_params.rb

@@ -108,7 +108,10 @@ module Telnyx
           extend Telnyx::Internal::Type::Enum
 
           LOCAL = :local
+          MOBILE = :mobile
+          MULTIPURPOSE = :multipurpose
           NATIONAL = :national
+          SHARED_COST = :shared_cost
           TOLL_FREE = :toll_free
 
           # @!method self.values

data/lib/telnyx/models/signature_payload.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class SignaturePayload < Telnyx::Internal::Type::BaseModel
+      # @!attribute image_base64
+      #   PNG image, base64-encoded.
+      #
+      #   @return [String]
+      required :image_base64, String
+
+      # @!attribute signer_name
+      #   Optional. When absent the rendered PDF falls back to the enterprise contact's
+      #   legal name.
+      #
+      #   @return [String, nil]
+      optional :signer_name, String, nil?: true
+
+      # @!method initialize(image_base64:, signer_name: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::SignaturePayload} for more details.
+      #
+      #   @param image_base64 [String] PNG image, base64-encoded.
+      #
+      #   @param signer_name [String, nil] Optional. When absent the rendered PDF falls back to the enterprise contact's le
+    end
+  end
+end

data/lib/telnyx/models/sip_registration_status_list_params.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::SipRegistrationStatus#list
+    class SipRegistrationStatusListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute credential_type
+      #   The kind of credential to look up. `uac_external_credential` is keyed by
+      #   `connection_id`; `telephony_credential` and `sip_credential_connection` are
+      #   keyed by `username`.
+      #
+      #   @return [Symbol, Telnyx::Models::SipRegistrationStatusListParams::CredentialType]
+      required :credential_type, enum: -> { Telnyx::SipRegistrationStatusListParams::CredentialType }
+
+      # @!attribute connection_id
+      #   Identifier of the UAC connection to look up. Required when `credential_type` is
+      #   `uac_external_credential`.
+      #
+      #   @return [String, nil]
+      optional :connection_id, String
+
+      # @!attribute username
+      #   SIP username to look up. Required when `credential_type` is
+      #   `telephony_credential` or `sip_credential_connection`.
+      #
+      #   @return [String, nil]
+      optional :username, String
+
+      # @!method initialize(credential_type:, connection_id: nil, username: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::SipRegistrationStatusListParams} for more details.
+      #
+      #   @param credential_type [Symbol, Telnyx::Models::SipRegistrationStatusListParams::CredentialType] The kind of credential to look up. `uac_external_credential` is keyed by `connec
+      #
+      #   @param connection_id [String] Identifier of the UAC connection to look up. Required when `credential_type` is
+      #
+      #   @param username [String] SIP username to look up. Required when `credential_type` is `telephony_credentia
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # The kind of credential to look up. `uac_external_credential` is keyed by
+      # `connection_id`; `telephony_credential` and `sip_credential_connection` are
+      # keyed by `username`.
+      module CredentialType
+        extend Telnyx::Internal::Type::Enum
+
+        UAC_EXTERNAL_CREDENTIAL = :uac_external_credential
+        TELEPHONY_CREDENTIAL = :telephony_credential
+        SIP_CREDENTIAL_CONNECTION = :sip_credential_connection
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/sip_registration_status_list_response.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::SipRegistrationStatus#list
+    class SipRegistrationStatusListResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute connection_id
+      #   Identifier of the connection associated with the credential.
+      #
+      #   @return [String, nil]
+      optional :connection_id, String
+
+      # @!attribute connection_name
+      #   Human-readable connection name.
+      #
+      #   @return [String, nil]
+      optional :connection_name, String
+
+      # @!attribute credential_type
+      #   The credential type that was looked up.
+      #
+      #   @return [Symbol, Telnyx::Models::SipRegistrationStatusListResponse::CredentialType, nil]
+      optional :credential_type, enum: -> { Telnyx::Models::SipRegistrationStatusListResponse::CredentialType }
+
+      # @!attribute credential_username
+      #   SIP username used for the registration.
+      #
+      #   @return [String, nil]
+      optional :credential_username, String
+
+      # @!attribute last_registration_response
+      #   SIP response from the last registration attempt.
+      #
+      #   @return [String, nil]
+      optional :last_registration_response, String, nil?: true
+
+      # @!attribute registered
+      #   True if the endpoint is currently registered.
+      #
+      #   @return [Boolean, nil]
+      optional :registered, Telnyx::Internal::Type::Boolean
+
+      # @!attribute sip_registration_details
+      #   Detailed registration information reported by the registrar. The populated
+      #   fields depend on `credential_type`: UAC external credentials report
+      #   `auth_retries`, `uptime`, `next_action_at`, `failures`, and `sip_uri_user_host`;
+      #   telephony credentials and SIP credential connections report `ua_ip`, `ua_port`,
+      #   `transport`, and `last_modified`. All types report `expires`, but its unit
+      #   differs by `credential_type` — see that field.
+      #
+      #   @return [Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationDetails, nil]
+      optional :sip_registration_details,
+               -> { Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationDetails }
+
+      # @!attribute sip_registration_status
+      #   Human-readable registration status derived from the registrar state.
+      #
+      #   @return [Symbol, Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationStatus, nil]
+      optional :sip_registration_status,
+               enum: -> { Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationStatus }
+
+      # @!method initialize(connection_id: nil, connection_name: nil, credential_type: nil, credential_username: nil, last_registration_response: nil, registered: nil, sip_registration_details: nil, sip_registration_status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::SipRegistrationStatusListResponse} for more details.
+      #
+      #   @param connection_id [String] Identifier of the connection associated with the credential.
+      #
+      #   @param connection_name [String] Human-readable connection name.
+      #
+      #   @param credential_type [Symbol, Telnyx::Models::SipRegistrationStatusListResponse::CredentialType] The credential type that was looked up.
+      #
+      #   @param credential_username [String] SIP username used for the registration.
+      #
+      #   @param last_registration_response [String, nil] SIP response from the last registration attempt.
+      #
+      #   @param registered [Boolean] True if the endpoint is currently registered.
+      #
+      #   @param sip_registration_details [Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationDetails] Detailed registration information reported by the registrar. The populated field
+      #
+      #   @param sip_registration_status [Symbol, Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationStatus] Human-readable registration status derived from the registrar state.
+
+      # The credential type that was looked up.
+      #
+      # @see Telnyx::Models::SipRegistrationStatusListResponse#credential_type
+      module CredentialType
+        extend Telnyx::Internal::Type::Enum
+
+        UAC_EXTERNAL_CREDENTIAL = :uac_external_credential
+        TELEPHONY_CREDENTIAL = :telephony_credential
+        SIP_CREDENTIAL_CONNECTION = :sip_credential_connection
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Telnyx::Models::SipRegistrationStatusListResponse#sip_registration_details
+      class SipRegistrationDetails < Telnyx::Internal::Type::BaseModel
+        # @!attribute auth_retries
+        #   Number of authentication retries on the last attempt (uac_external_credential).
+        #
+        #   @return [Integer, nil]
+        optional :auth_retries, Integer
+
+        # @!attribute expires
+        #   When the current registration expires. The unit depends on `credential_type`:
+        #   for `uac_external_credential` this is a Unix timestamp (seconds since epoch) of
+        #   the next scheduled re-registration; for `telephony_credential` and
+        #   `sip_credential_connection` this is the registration lifetime in seconds as
+        #   negotiated with the registrar (the `Expires` value, defaulting to 3600 when the
+        #   endpoint sends none).
+        #
+        #   @return [Integer, nil]
+        optional :expires, Integer
+
+        # @!attribute failures
+        #   Count of consecutive registration failures (uac_external_credential).
+        #
+        #   @return [Integer, nil]
+        optional :failures, Integer
+
+        # @!attribute last_modified
+        #   Timestamp when the registration was last modified (telephony_credential and
+        #   sip_credential_connection).
+        #
+        #   @return [String, nil]
+        optional :last_modified, String
+
+        # @!attribute next_action_at
+        #   Unix timestamp of the next scheduled registration action
+        #   (uac_external_credential).
+        #
+        #   @return [Integer, nil]
+        optional :next_action_at, Integer
+
+        # @!attribute sip_uri_user_host
+        #   SIP URI user@host of the registered contact (uac_external_credential).
+        #
+        #   @return [String, nil]
+        optional :sip_uri_user_host, String
+
+        # @!attribute transport
+        #   Transport used for the registration, e.g. UDP/TCP/TLS (telephony_credential and
+        #   sip_credential_connection).
+        #
+        #   @return [String, nil]
+        optional :transport, String
+
+        # @!attribute ua_ip
+        #   IP address of the registered user agent (telephony_credential and
+        #   sip_credential_connection).
+        #
+        #   @return [String, nil]
+        optional :ua_ip, String
+
+        # @!attribute ua_port
+        #   Port of the registered user agent (telephony_credential and
+        #   sip_credential_connection).
+        #
+        #   @return [Integer, nil]
+        optional :ua_port, Integer
+
+        # @!attribute uptime
+        #   Registration uptime reported by the registrar (uac_external_credential).
+        #
+        #   @return [Integer, nil]
+        optional :uptime, Integer
+
+        # @!method initialize(auth_retries: nil, expires: nil, failures: nil, last_modified: nil, next_action_at: nil, sip_uri_user_host: nil, transport: nil, ua_ip: nil, ua_port: nil, uptime: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::SipRegistrationStatusListResponse::SipRegistrationDetails} for
+        #   more details.
+        #
+        #   Detailed registration information reported by the registrar. The populated
+        #   fields depend on `credential_type`: UAC external credentials report
+        #   `auth_retries`, `uptime`, `next_action_at`, `failures`, and `sip_uri_user_host`;
+        #   telephony credentials and SIP credential connections report `ua_ip`, `ua_port`,
+        #   `transport`, and `last_modified`. All types report `expires`, but its unit
+        #   differs by `credential_type` — see that field.
+        #
+        #   @param auth_retries [Integer] Number of authentication retries on the last attempt (uac_external_credential).
+        #
+        #   @param expires [Integer] When the current registration expires. The unit depends on `credential_type`: fo
+        #
+        #   @param failures [Integer] Count of consecutive registration failures (uac_external_credential).
+        #
+        #   @param last_modified [String] Timestamp when the registration was last modified (telephony*credential and sip*
+        #
+        #   @param next_action_at [Integer] Unix timestamp of the next scheduled registration action (uac_external_credentia
+        #
+        #   @param sip_uri_user_host [String] SIP URI user@host of the registered contact (uac_external_credential).
+        #
+        #   @param transport [String] Transport used for the registration, e.g. UDP/TCP/TLS (telephony_credential and
+        #
+        #   @param ua_ip [String] IP address of the registered user agent (telephony_credential and sip_credential
+        #
+        #   @param ua_port [Integer] Port of the registered user agent (telephony_credential and sip_credential_conne
+        #
+        #   @param uptime [Integer] Registration uptime reported by the registrar (uac_external_credential).
+      end
+
+      # Human-readable registration status derived from the registrar state.
+      #
+      # @see Telnyx::Models::SipRegistrationStatusListResponse#sip_registration_status
+      module SipRegistrationStatus
+        extend Telnyx::Internal::Type::Enum
+
+        UNREGISTERING = :unregistering
+        CONNECTION_DISABLED = :connection_disabled
+        STANDBY = :standby
+        FAILED = :failed
+        TRYING = :trying
+        REGISTERED = :registered
+        UNKNOWN = :unknown
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end