telnyx 5.151.0 → 5.153.0

data/lib/telnyx/models/storage/kvs/key_update_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      module Kvs
+        # @see Telnyx::Resources::Storage::Kvs::Keys#update
+        class KeyUpdateParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute key
+          #
+          #   @return [String]
+          required :key, String
+
+          # @!attribute body
+          #   Raw value bytes, stored verbatim.
+          #
+          #   @return [Pathname, StringIO, IO, String, Telnyx::FilePart]
+          required :body, Telnyx::Internal::Type::FileInput
+
+          # @!attribute ttl_secs
+          #   Time-to-live in seconds. When set, the key expires and is deleted after this
+          #   duration. Requires a namespace provisioned with TTL support; namespaces without
+          #   it return a `409`.
+          #
+          #   @return [Integer, nil]
+          optional :ttl_secs, Integer
+
+          # @!method initialize(id:, key:, body:, ttl_secs: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::Storage::Kvs::KeyUpdateParams} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param key [String]
+          #
+          #   @param body [Pathname, StringIO, IO, String, Telnyx::FilePart] Raw value bytes, stored verbatim.
+          #
+          #   @param ttl_secs [Integer] Time-to-live in seconds. When set, the key expires and is deleted after this dur
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/uac_inbound.rb

@@ -78,6 +78,13 @@ module Telnyx
       #   @return [Boolean, nil]
       optional :sip_compact_headers_enabled, Telnyx::Internal::Type::Boolean
 
+      # @!attribute sip_region
+      #   Selects which `sip_region` to receive inbound calls from. If null, the default
+      #   region (US) will be used.
+      #
+      #   @return [Symbol, Telnyx::Models::UacInbound::SipRegion, nil]
+      optional :sip_region, enum: -> { Telnyx::UacInbound::SipRegion }
+
       # @!attribute sip_subdomain
       #   The Telnyx-generated SIP subdomain for this UAC connection.
       #
@@ -102,7 +109,7 @@ module Telnyx
       #   @return [Integer, nil]
       optional :timeout_2xx_secs, Integer
 
-      # @!method initialize(ani_number_format: nil, channel_limit: nil, codecs: nil, default_routing_method: nil, dnis_number_format: nil, generate_ringback_tone: nil, isup_headers_enabled: nil, prack_enabled: nil, shaken_stir_enabled: nil, simultaneous_ringing: nil, sip_compact_headers_enabled: nil, sip_subdomain: nil, sip_subdomain_receive_settings: nil, timeout_1xx_secs: nil, timeout_2xx_secs: nil)
+      # @!method initialize(ani_number_format: nil, channel_limit: nil, codecs: nil, default_routing_method: nil, dnis_number_format: nil, generate_ringback_tone: nil, isup_headers_enabled: nil, prack_enabled: nil, shaken_stir_enabled: nil, simultaneous_ringing: nil, sip_compact_headers_enabled: nil, sip_region: nil, sip_subdomain: nil, sip_subdomain_receive_settings: nil, timeout_1xx_secs: nil, timeout_2xx_secs: nil)
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::UacInbound} for more details.
       #
@@ -128,6 +135,8 @@ module Telnyx
       #
       #   @param sip_compact_headers_enabled [Boolean] Defaults to true.
       #
+      #   @param sip_region [Symbol, Telnyx::Models::UacInbound::SipRegion] Selects which `sip_region` to receive inbound calls from. If null, the default r
+      #
       #   @param sip_subdomain [String] The Telnyx-generated SIP subdomain for this UAC connection.
       #
       #   @param sip_subdomain_receive_settings [Symbol, Telnyx::Models::UacInbound::SipSubdomainReceiveSettings] Controls which SIP URI callers may reach this connection.
@@ -193,6 +202,21 @@ module Telnyx
         #   @return [Array<Symbol>]
       end
 
+      # Selects which `sip_region` to receive inbound calls from. If null, the default
+      # region (US) will be used.
+      #
+      # @see Telnyx::Models::UacInbound#sip_region
+      module SipRegion
+        extend Telnyx::Internal::Type::Enum
+
+        US = :US
+        EUROPE = :Europe
+        AUSTRALIA = :Australia
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # Controls which SIP URI callers may reach this connection.
       #
       # @see Telnyx::Models::UacInbound#sip_subdomain_receive_settings

data/lib/telnyx/models/uac_inbound_request.rb

@@ -78,6 +78,13 @@ module Telnyx
       #   @return [Boolean, nil]
       optional :sip_compact_headers_enabled, Telnyx::Internal::Type::Boolean
 
+      # @!attribute sip_region
+      #   Selects which `sip_region` to receive inbound calls from. If null, the default
+      #   region (US) will be used.
+      #
+      #   @return [Symbol, Telnyx::Models::UacInboundRequest::SipRegion, nil]
+      optional :sip_region, enum: -> { Telnyx::UacInboundRequest::SipRegion }
+
       # @!attribute timeout_1xx_secs
       #   Time(sec) before aborting if connection is not made.
       #
@@ -90,7 +97,7 @@ module Telnyx
       #   @return [Integer, nil]
       optional :timeout_2xx_secs, Integer
 
-      # @!method initialize(ani_number_format: nil, channel_limit: nil, codecs: nil, default_routing_method: nil, dnis_number_format: nil, generate_ringback_tone: nil, isup_headers_enabled: nil, prack_enabled: nil, shaken_stir_enabled: nil, simultaneous_ringing: nil, sip_compact_headers_enabled: nil, timeout_1xx_secs: nil, timeout_2xx_secs: nil)
+      # @!method initialize(ani_number_format: nil, channel_limit: nil, codecs: nil, default_routing_method: nil, dnis_number_format: nil, generate_ringback_tone: nil, isup_headers_enabled: nil, prack_enabled: nil, shaken_stir_enabled: nil, simultaneous_ringing: nil, sip_compact_headers_enabled: nil, sip_region: nil, timeout_1xx_secs: nil, timeout_2xx_secs: nil)
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::UacInboundRequest} for more details.
       #
@@ -120,6 +127,8 @@ module Telnyx
       #
       #   @param sip_compact_headers_enabled [Boolean] Defaults to true.
       #
+      #   @param sip_region [Symbol, Telnyx::Models::UacInboundRequest::SipRegion] Selects which `sip_region` to receive inbound calls from. If null, the default r
+      #
       #   @param timeout_1xx_secs [Integer] Time(sec) before aborting if connection is not made.
       #
       #   @param timeout_2xx_secs [Integer] Time(sec) before aborting if call is unanswered (min: 1, max: 600).
@@ -180,6 +189,21 @@ module Telnyx
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # Selects which `sip_region` to receive inbound calls from. If null, the default
+      # region (US) will be used.
+      #
+      # @see Telnyx::Models::UacInboundRequest#sip_region
+      module SipRegion
+        extend Telnyx::Internal::Type::Enum
+
+        US = :US
+        EUROPE = :Europe
+        AUSTRALIA = :Australia
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Whatsapp
+      # @see Telnyx::Resources::Whatsapp::PhoneNumbers#retrieve_conversation_window
+      class PhoneNumberRetrieveConversationWindowParams < 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 destination_number
+        #   Destination phone number in E.164 format
+        #
+        #   @return [String]
+        required :destination_number, String
+
+        # @!method initialize(phone_number:, destination_number:, request_options: {})
+        #   @param phone_number [String]
+        #
+        #   @param destination_number [String] Destination phone number in E.164 format
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Whatsapp
+      # @see Telnyx::Resources::Whatsapp::PhoneNumbers#retrieve_conversation_window
+      class PhoneNumberRetrieveConversationWindowResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::Whatsapp::PhoneNumberRetrieveConversationWindowResponse::Data, nil]
+        optional :data, -> { Telnyx::Models::Whatsapp::PhoneNumberRetrieveConversationWindowResponse::Data }
+
+        # @!method initialize(data: nil)
+        #   @param data [Telnyx::Models::Whatsapp::PhoneNumberRetrieveConversationWindowResponse::Data]
+
+        # @see Telnyx::Models::Whatsapp::PhoneNumberRetrieveConversationWindowResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute last_user_message_at
+          #   Timestamp of the last inbound message that opened the window
+          #
+          #   @return [Time, nil]
+          optional :last_user_message_at, Time
+
+          # @!attribute window_active
+          #   Whether the 24-hour conversation window is currently open
+          #
+          #   @return [Boolean, nil]
+          optional :window_active, Telnyx::Internal::Type::Boolean
+
+          # @!attribute window_expires_at
+          #   When the window closes. Null if no active window.
+          #
+          #   @return [Time, nil]
+          optional :window_expires_at, Time
+
+          # @!attribute window_type
+          #   Window type. Currently always 24h when present.
+          #
+          #   @return [String, nil]
+          optional :window_type, String
+
+          # @!method initialize(last_user_message_at: nil, window_active: nil, window_expires_at: nil, window_type: nil)
+          #   @param last_user_message_at [Time] Timestamp of the last inbound message that opened the window
+          #
+          #   @param window_active [Boolean] Whether the 24-hour conversation window is currently open
+          #
+          #   @param window_expires_at [Time] When the window closes. Null if no active window.
+          #
+          #   @param window_type [String] Window type. Currently always 24h when present.
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/dir/references.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Dir
+      # Submit and manage the two business references and one financial reference that
+      # vouch for a DIR. References are contacted to confirm the business identity
+      # during vetting.
+      class References
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Dir::ReferenceCreateParams} for more details.
+        #
+        # Submit the two business references and one financial reference for a DIR.
+        #
+        # The DIR's authorizer email must be verified first (see the email-verification
+        # endpoint). Until it is, this returns `409` and no references are stored.
+        #
+        # The request body carries exactly two business references plus one financial
+        # reference. On success the references are stored and the response echoes them in
+        # the same shape as the GET. Submitting again converges on the already-stored
+        # references rather than erroring.
+        #
+        # @overload create(dir_id, business_references:, financial_reference:, request_options: {})
+        #
+        # @param dir_id [String] The DIR id. Lowercase UUID.
+        #
+        # @param business_references [Array<Telnyx::Models::Dir::ReferenceInput>] Exactly two business references.
+        #
+        # @param financial_reference [Telnyx::Models::Dir::ReferenceInput] One reference supplied at submit. The reference type is implied by the field tha
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Dir::ReferenceList]
+        #
+        # @see Telnyx::Models::Dir::ReferenceCreateParams
+        def create(dir_id, params)
+          parsed, options = Telnyx::Dir::ReferenceCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["dir/%1$s/references", dir_id],
+            body: parsed,
+            model: Telnyx::Dir::ReferenceList,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Dir::ReferenceUpdateParams} for more details.
+        #
+        # Partially update one reference, addressed by the DIR id plus the reference's
+        # type (business or financial) and slot.
+        #
+        # Cosmetic fields (full name, job title, organization, relationship, email) are
+        # always editable. The phone number and timezone may only be changed while a
+        # scheduled call has not yet been dialed; if a call is in progress or all attempts
+        # are complete, those fields are locked. Changing the timezone reschedules any
+        # pending call into the new local calling window.
+        #
+        # @overload update(slot, dir_id:, ref_type:, email: nil, full_name: nil, job_title: nil, organization: nil, phone_e164: nil, relationship_to_registrant: nil, timezone: nil, request_options: {})
+        #
+        # @param slot [Integer] Path param: Reference slot. Business references use slots 0 and 1; the financial
+        #
+        # @param dir_id [String] Path param: The DIR id. Lowercase UUID.
+        #
+        # @param ref_type [Symbol, Telnyx::Models::Dir::ReferenceUpdateParams::RefType] Path param: Reference type to address.
+        #
+        # @param email [String] Body param: Reference contact email address.
+        #
+        # @param full_name [String] Body param: Full name of the reference contact.
+        #
+        # @param job_title [String, nil] Body param: Job title of the reference contact.
+        #
+        # @param organization [String, nil] Body param: Organization the reference contact belongs to.
+        #
+        # @param phone_e164 [String] Body param: Reference phone number in E.164 format.
+        #
+        # @param relationship_to_registrant [String, nil] Body param: How the reference contact is related to the registering business.
+        #
+        # @param timezone [String] Body param: IANA timezone id for the reference.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Dir::ReferenceUpdateResponse]
+        #
+        # @see Telnyx::Models::Dir::ReferenceUpdateParams
+        def update(slot, params)
+          parsed, options = Telnyx::Dir::ReferenceUpdateParams.dump_request(params)
+          dir_id =
+            parsed.delete(:dir_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          ref_type =
+            parsed.delete(:ref_type) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :patch,
+            path: ["dir/%1$s/references/%2$s/%3$s", dir_id, ref_type, slot],
+            body: parsed,
+            model: Telnyx::Models::Dir::ReferenceUpdateResponse,
+            options: options
+          )
+        end
+
+        # List the business and financial references submitted for a DIR.
+        #
+        # Returns the two business references (slots 0 and 1) followed by the single
+        # financial reference. Each entry carries only the customer-supplied details
+        # (name, title, organization, relationship, phone, email, timezone). Returns an
+        # empty list when no references were submitted.
+        #
+        # @overload list(dir_id, request_options: {})
+        #
+        # @param dir_id [String] The DIR id. Lowercase UUID.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Dir::ReferenceList]
+        #
+        # @see Telnyx::Models::Dir::ReferenceListParams
+        def list(dir_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["dir/%1$s/references", dir_id],
+            model: Telnyx::Dir::ReferenceList,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/dir/verify_email.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Dir
+      # Verify ownership of a DIR's authorizer email. A short code is emailed and
+      # confirmed; the email must be verified before references can be submitted.
+      class VerifyEmail
+        # Email a 6-digit code to the DIR's authorizer email to confirm ownership of that
+        # address.
+        #
+        # The code expires in 15 minutes. Requesting a new code invalidates any previous
+        # one. Resends are rate limited (a short cooldown plus a daily cap). Submit the
+        # code to `POST /dir/{dir_id}/verify_email/confirm`.
+        #
+        # @overload create(dir_id, request_options: {})
+        #
+        # @param dir_id [String] The DIR id. Lowercase UUID.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Dir::EmailVerificationStatusWrapped]
+        #
+        # @see Telnyx::Models::Dir::VerifyEmailCreateParams
+        def create(dir_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["dir/%1$s/verify_email", dir_id],
+            model: Telnyx::Dir::EmailVerificationStatusWrapped,
+            options: params[:request_options]
+          )
+        end
+
+        # Whether the DIR's current authorizer email has been verified.
+        #
+        # @overload list(dir_id, request_options: {})
+        #
+        # @param dir_id [String] The DIR id. Lowercase UUID.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Dir::EmailVerificationStatusWrapped]
+        #
+        # @see Telnyx::Models::Dir::VerifyEmailListParams
+        def list(dir_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["dir/%1$s/verify_email", dir_id],
+            model: Telnyx::Dir::EmailVerificationStatusWrapped,
+            options: params[:request_options]
+          )
+        end
+
+        # Submit the 6-digit code that was emailed to the DIR's authorizer email. On
+        # success the authorizer email is marked verified.
+        #
+        # For security, any failure (wrong, expired, already-used, or too many attempts)
+        # returns the same generic message.
+        #
+        # @overload confirm(dir_id, code:, request_options: {})
+        #
+        # @param dir_id [String] The DIR id. Lowercase UUID.
+        #
+        # @param code [String] The 6-digit code sent to the authorizer email.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Dir::EmailVerificationStatusWrapped]
+        #
+        # @see Telnyx::Models::Dir::VerifyEmailConfirmParams
+        def confirm(dir_id, params)
+          parsed, options = Telnyx::Dir::VerifyEmailConfirmParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["dir/%1$s/verify_email/confirm", dir_id],
+            body: parsed,
+            model: Telnyx::Dir::EmailVerificationStatusWrapped,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/dir.rb

@@ -18,6 +18,17 @@ module Telnyx
       # @return [Telnyx::Resources::Dir::PhoneNumbers]
       attr_reader :phone_numbers
 
+      # Submit and manage the two business references and one financial reference that
+      # vouch for a DIR. References are contacted to confirm the business identity
+      # during vetting.
+      # @return [Telnyx::Resources::Dir::References]
+      attr_reader :references
+
+      # Verify ownership of a DIR's authorizer email. A short code is emailed and
+      # confirmed; the email must be verified before references can be submitted.
+      # @return [Telnyx::Resources::Dir::VerifyEmail]
+      attr_reader :verify_email
+
       # Returns a single DIR by id. The enterprise is resolved server-side from the DIR
       # id. Returns `404` if the DIR does not exist or is not yours.
       #
@@ -298,6 +309,9 @@ module Telnyx
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::DirUpdateInfringementParams} for more details.
+      #
       # Push a fix for a DIR that is `suspended` with an open infringement claim back
       # into vetting. `POST /dir/{dir_id}/submit` is blocked while a claim is open, so
       # this is the customer-callable path to update the DIR's content and re-certify
@@ -323,7 +337,7 @@ module Telnyx
       #
       # @param display_name [String, nil]
       #
-      # @param documents [Array<Telnyx::Models::Document>, nil] Append-only supporting documents.
+      # @param documents [Array<Telnyx::Models::Document>, nil] Append-only supporting documents to attach while resolving the claim (e.g. autho
       #
       # @param logo_url [String, nil] Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
       #
@@ -351,6 +365,8 @@ module Telnyx
         @comments = Telnyx::Resources::Dir::Comments.new(client: client)
         @phone_number_batches = Telnyx::Resources::Dir::PhoneNumberBatches.new(client: client)
         @phone_numbers = Telnyx::Resources::Dir::PhoneNumbers.new(client: client)
+        @references = Telnyx::Resources::Dir::References.new(client: client)
+        @verify_email = Telnyx::Resources::Dir::VerifyEmail.new(client: client)
       end
     end
   end

data/lib/telnyx/resources/documents.rb

@@ -120,7 +120,7 @@ module Telnyx
         @client.request(
           method: :get,
           path: ["documents/%1$s/download", id],
-          headers: {"accept" => "*"},
+          headers: {"accept" => "application/octet-stream"},
           model: StringIO,
           options: params[:request_options]
         )

data/lib/telnyx/resources/enterprises/dir.rb

@@ -35,7 +35,7 @@ module Telnyx
         #   `POST /enterprises/{id}/branded_calling`).
         # - `404` - enterprise does not exist or does not belong to your account.
         #
-        # @overload create(enterprise_id, authorizer_email:, authorizer_name:, certify_brand_is_accurate:, certify_ip_ownership:, certify_no_shaft_content:, display_name:, call_reasons: nil, documents: nil, logo_url: nil, reselling: nil, request_options: {})
+        # @overload create(enterprise_id, authorizer_email:, authorizer_name:, call_reasons:, certify_brand_is_accurate:, certify_ip_ownership:, certify_no_shaft_content:, display_name:, documents: nil, logo_url: nil, reselling: nil, request_options: {})
         #
         # @param enterprise_id [String] The enterprise id. Lowercase UUID.
         #
@@ -43,6 +43,8 @@ module Telnyx
         #
         # @param authorizer_name [String] Name of the person at your enterprise who is authorizing this DIR registration.
         #
+        # @param call_reasons [Array<String>] 1–10 reasons your business calls customers. Validate phrasing against `POST /cal
+        #
         # @param certify_brand_is_accurate [Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyBrandIsAccurate] Must be `true`.
         #
         # @param certify_ip_ownership [Boolean, Telnyx::Models::Enterprises::DirCreateParams::CertifyIPOwnership] Must be `true`. Confirms ownership of any logos/trademarks shown.
@@ -51,8 +53,6 @@ module Telnyx
         #
         # @param display_name [String] Name shown to call recipients. No emoji; not whitespace-only.
         #
-        # @param call_reasons [Array<String>] 1–10 reasons your business calls customers. Validate phrasing against `POST /cal
-        #
         # @param documents [Array<Telnyx::Models::Document>] Supporting documents. Each `document_id` may appear at most once on a DIR.
         #
         # @param logo_url [String] Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).