telnyx 5.150.0 → 5.152.0

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).

data/lib/telnyx/resources/storage/kvs/keys.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Storage
+      class Kvs
+        # Read and write keys within a KV namespace
+        class Keys
+          # Some parameter documentations has been truncated, see
+          # {Telnyx::Models::Storage::Kvs::KeyRetrieveParams} for more details.
+          #
+          # Returns the raw stored value for a key. The response body is the value exactly
+          # as it was written; the `Content-Type` header echoes the value's stored content
+          # type (defaults to `application/octet-stream`).
+          #
+          # @overload retrieve(key, id:, request_options: {})
+          #
+          # @param key [String] Key name. Allowed characters: `a-z A-Z 0-9 - _ / = .`; maximum 256 characters; n
+          #
+          # @param id [String] KV namespace ID
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [StringIO]
+          #
+          # @see Telnyx::Models::Storage::Kvs::KeyRetrieveParams
+          def retrieve(key, params)
+            parsed, options = Telnyx::Storage::Kvs::KeyRetrieveParams.dump_request(params)
+            id =
+              parsed.delete(:id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :get,
+              path: ["storage/kvs/%1$s/keys/%2$s", id, key],
+              headers: {"accept" => "*/*"},
+              model: StringIO,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {Telnyx::Models::Storage::Kvs::KeyUpdateParams} for more details.
+          #
+          # Creates or replaces the value for a key. The request body is stored verbatim as
+          # the value — no base64, no JSON envelope — up to 1 MiB. The request's
+          # `Content-Type` header is stored with the value and echoed back on retrieval.
+          # Returns `201` when the key is created and `200` when an existing key is updated.
+          #
+          # @overload update(key, id:, body:, ttl_secs: nil, request_options: {})
+          #
+          # @param key [String] Path param: Key name. Allowed characters: `a-z A-Z 0-9 - _ / = .`; maximum 256 c
+          #
+          # @param id [String] Path param: KV namespace ID
+          #
+          # @param body [Pathname, StringIO, IO, String, Telnyx::FilePart] Body param: Raw value bytes, stored verbatim.
+          #
+          # @param ttl_secs [Integer] Query param: Time-to-live in seconds. When set, the key expires and is deleted a
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see Telnyx::Models::Storage::Kvs::KeyUpdateParams
+          def update(key, params)
+            parsed, options = Telnyx::Storage::Kvs::KeyUpdateParams.dump_request(params)
+            query = Telnyx::Internal::Util.encode_query_params(parsed.except(:body))
+            id =
+              parsed.delete(:id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :put,
+              path: ["storage/kvs/%1$s/keys/%2$s", id, key],
+              query: query,
+              headers: {"content-type" => "*/*"},
+              body: parsed[:body],
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # Lists the keys in a namespace. Returns key names and metadata only, never
+          # values. Results are paginated with `limit` and an opaque `cursor`.
+          #
+          # @overload list(id, cursor: nil, limit: nil, prefix: nil, request_options: {})
+          #
+          # @param id [String] KV namespace ID
+          #
+          # @param cursor [String] Opaque pagination cursor from a previous response's `meta.cursor`.
+          #
+          # @param limit [Integer] Maximum number of keys to return. Values above 1000 are treated as 1000.
+          #
+          # @param prefix [String] Return only keys that start with this prefix.
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::Storage::Kvs::KeyListResponse]
+          #
+          # @see Telnyx::Models::Storage::Kvs::KeyListParams
+          def list(id, params = {})
+            parsed, options = Telnyx::Storage::Kvs::KeyListParams.dump_request(params)
+            query = Telnyx::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: ["storage/kvs/%1$s/keys", id],
+              query: query,
+              model: Telnyx::Models::Storage::Kvs::KeyListResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {Telnyx::Models::Storage::Kvs::KeyDeleteParams} for more details.
+          #
+          # Deletes a key. Idempotent: deleting a key that does not exist still succeeds.
+          # The namespace itself must exist and be provisioned.
+          #
+          # @overload delete(key, id:, request_options: {})
+          #
+          # @param key [String] Key name. Allowed characters: `a-z A-Z 0-9 - _ / = .`; maximum 256 characters; n
+          #
+          # @param id [String] KV namespace ID
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see Telnyx::Models::Storage::Kvs::KeyDeleteParams
+          def delete(key, params)
+            parsed, options = Telnyx::Storage::Kvs::KeyDeleteParams.dump_request(params)
+            id =
+              parsed.delete(:id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :delete,
+              path: ["storage/kvs/%1$s/keys/%2$s", id, key],
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Telnyx::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/storage/kvs.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class Storage
+      # Manage KV storage namespaces
+      class Kvs
+        # Read and write keys within a KV namespace
+        # @return [Telnyx::Resources::Storage::Kvs::Keys]
+        attr_reader :keys
+
+        # Creates a new KV namespace. Provisioning is asynchronous: the namespace is
+        # returned with status `pending` and becomes usable once it reaches
+        # `provision_ok`.
+        #
+        # @overload create(name:, request_options: {})
+        #
+        # @param name [String] Namespace name. May contain lowercase letters, numbers, and hyphens only.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Storage::KvNamespaceResponseWrapper]
+        #
+        # @see Telnyx::Models::Storage::KvCreateParams
+        def create(params)
+          parsed, options = Telnyx::Storage::KvCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "storage/kvs",
+            body: parsed,
+            model: Telnyx::Storage::KvNamespaceResponseWrapper,
+            options: options
+          )
+        end
+
+        # Retrieves a KV namespace by its ID, including its provisioning status.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] KV namespace ID
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Storage::KvNamespaceResponseWrapper]
+        #
+        # @see Telnyx::Models::Storage::KvRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["storage/kvs/%1$s", id],
+            model: Telnyx::Storage::KvNamespaceResponseWrapper,
+            options: params[:request_options]
+          )
+        end
+
+        # Lists the KV namespaces for the authenticated user's organization. Results use
+        # page-based pagination (`page[number]`/`page[size]`).
+        #
+        # @overload list(page_number: nil, page_size: nil, request_options: {})
+        #
+        # @param page_number [Integer] The page number to load.
+        #
+        # @param page_size [Integer] The size of the page. Values above 250 are treated as 250.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Storage::KvNamespace>]
+        #
+        # @see Telnyx::Models::Storage::KvListParams
+        def list(params = {})
+          parsed, options = Telnyx::Storage::KvListParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "storage/kvs",
+            query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+            page: Telnyx::Internal::DefaultFlatPagination,
+            model: Telnyx::Storage::KvNamespace,
+            options: options
+          )
+        end
+
+        # Deletes a KV namespace and all of the keys it contains. Deletion is
+        # asynchronous: the namespace is returned with status `deleting`. Deleting a
+        # namespace whose deletion is already in progress returns a `409`.
+        #
+        # @overload delete(id, request_options: {})
+        #
+        # @param id [String] KV namespace ID
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Storage::KvNamespaceResponseWrapper]
+        #
+        # @see Telnyx::Models::Storage::KvDeleteParams
+        def delete(id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["storage/kvs/%1$s", id],
+            model: Telnyx::Storage::KvNamespaceResponseWrapper,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+          @keys = Telnyx::Resources::Storage::Kvs::Keys.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/storage.rb

@@ -16,6 +16,10 @@ module Telnyx
       # @return [Telnyx::Resources::Storage::Migrations]
       attr_reader :migrations
 
+      # Manage KV storage namespaces
+      # @return [Telnyx::Resources::Storage::Kvs]
+      attr_reader :kvs
+
       # List Migration Source coverage
       #
       # @overload list_migration_source_coverage(request_options: {})
@@ -42,6 +46,7 @@ module Telnyx
         @buckets = Telnyx::Resources::Storage::Buckets.new(client: client)
         @migration_sources = Telnyx::Resources::Storage::MigrationSources.new(client: client)
         @migrations = Telnyx::Resources::Storage::Migrations.new(client: client)
+        @kvs = Telnyx::Resources::Storage::Kvs.new(client: client)
       end
     end
   end

data/lib/telnyx/resources/whatsapp/phone_numbers.rb

@@ -81,6 +81,33 @@ module Telnyx
           )
         end
 
+        # Returns whether the 24-hour conversation window is currently open for a given
+        # source/destination pair. If window_active is false, only template messages may
+        # be sent.
+        #
+        # @overload retrieve_conversation_window(phone_number, destination_number:, request_options: {})
+        #
+        # @param phone_number [String] Phone number (E.164 format)
+        #
+        # @param destination_number [String] Destination phone number in E.164 format
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Whatsapp::PhoneNumberRetrieveConversationWindowResponse]
+        #
+        # @see Telnyx::Models::Whatsapp::PhoneNumberRetrieveConversationWindowParams
+        def retrieve_conversation_window(phone_number, params)
+          parsed, options = Telnyx::Whatsapp::PhoneNumberRetrieveConversationWindowParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["v2/whatsapp/phone_numbers/%1$s/conversation_window", phone_number],
+            query: query,
+            model: Telnyx::Models::Whatsapp::PhoneNumberRetrieveConversationWindowResponse,
+            options: options
+          )
+        end
+
         # Submit verification code for a phone number
         #
         # @overload verify(phone_number, code:, request_options: {})

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "5.150.0"
+  VERSION = "5.152.0"
 end

data/lib/telnyx.rb

@@ -688,6 +688,7 @@ require_relative "telnyx/models/calls/transcription_engine_azure_config"
 require_relative "telnyx/models/calls/transcription_engine_b_config"
 require_relative "telnyx/models/calls/transcription_engine_deepgram_config"
 require_relative "telnyx/models/calls/transcription_engine_google_config"
+require_relative "telnyx/models/calls/transcription_engine_parakeet_config"
 require_relative "telnyx/models/calls/transcription_engine_soniox_config"
 require_relative "telnyx/models/calls/transcription_engine_speechmatics_config"
 require_relative "telnyx/models/calls/transcription_engine_telnyx_config"
@@ -870,6 +871,7 @@ require_relative "telnyx/models/dir/comment_type"
 require_relative "telnyx/models/dir/dir_comment"
 require_relative "telnyx/models/dir/dir_phone_number"
 require_relative "telnyx/models/dir/dir_phone_number_status"
+require_relative "telnyx/models/dir/email_verification_status_wrapped"
 require_relative "telnyx/models/dir/phone_number_add_params"
 require_relative "telnyx/models/dir/phone_number_add_response"
 require_relative "telnyx/models/dir/phone_number_batch"
@@ -879,7 +881,17 @@ require_relative "telnyx/models/dir/phone_number_batch_retrieve_response"
 require_relative "telnyx/models/dir/phone_number_list_params"
 require_relative "telnyx/models/dir/phone_number_remove_params"
 require_relative "telnyx/models/dir/phone_number_remove_response"
+require_relative "telnyx/models/dir/reference"
+require_relative "telnyx/models/dir/reference_create_params"
+require_relative "telnyx/models/dir/reference_input"
+require_relative "telnyx/models/dir/reference_list"
+require_relative "telnyx/models/dir/reference_list_params"
+require_relative "telnyx/models/dir/reference_update_params"
+require_relative "telnyx/models/dir/reference_update_response"
 require_relative "telnyx/models/dir/rejection_reason"
+require_relative "telnyx/models/dir/verify_email_confirm_params"
+require_relative "telnyx/models/dir/verify_email_create_params"
+require_relative "telnyx/models/dir/verify_email_list_params"
 require_relative "telnyx/models/dir"
 require_relative "telnyx/models/dir_delete_params"
 require_relative "telnyx/models/dir_list"
@@ -2146,6 +2158,17 @@ require_relative "telnyx/models/storage/buckets/usage_get_api_usage_params"
 require_relative "telnyx/models/storage/buckets/usage_get_api_usage_response"
 require_relative "telnyx/models/storage/buckets/usage_get_bucket_usage_params"
 require_relative "telnyx/models/storage/buckets/usage_get_bucket_usage_response"
+require_relative "telnyx/models/storage/kv_create_params"
+require_relative "telnyx/models/storage/kv_delete_params"
+require_relative "telnyx/models/storage/kv_list_params"
+require_relative "telnyx/models/storage/kv_namespace"
+require_relative "telnyx/models/storage/kv_namespace_response_wrapper"
+require_relative "telnyx/models/storage/kv_retrieve_params"
+require_relative "telnyx/models/storage/kvs/key_delete_params"
+require_relative "telnyx/models/storage/kvs/key_list_params"
+require_relative "telnyx/models/storage/kvs/key_list_response"
+require_relative "telnyx/models/storage/kvs/key_retrieve_params"
+require_relative "telnyx/models/storage/kvs/key_update_params"
 require_relative "telnyx/models/storage/migration_create_params"
 require_relative "telnyx/models/storage/migration_create_response"
 require_relative "telnyx/models/storage/migration_list_params"
@@ -2441,6 +2464,8 @@ require_relative "telnyx/models/whatsapp/phone_number_delete_params"
 require_relative "telnyx/models/whatsapp/phone_number_list_params"
 require_relative "telnyx/models/whatsapp/phone_number_list_response"
 require_relative "telnyx/models/whatsapp/phone_number_resend_verification_params"
+require_relative "telnyx/models/whatsapp/phone_number_retrieve_conversation_window_params"
+require_relative "telnyx/models/whatsapp/phone_number_retrieve_conversation_window_response"
 require_relative "telnyx/models/whatsapp/phone_numbers/calling_setting_retrieve_params"
 require_relative "telnyx/models/whatsapp/phone_numbers/calling_setting_retrieve_response"
 require_relative "telnyx/models/whatsapp/phone_numbers/calling_setting_update_params"
@@ -2613,6 +2638,8 @@ require_relative "telnyx/resources/dir"
 require_relative "telnyx/resources/dir/comments"
 require_relative "telnyx/resources/dir/phone_number_batches"
 require_relative "telnyx/resources/dir/phone_numbers"
+require_relative "telnyx/resources/dir/references"
+require_relative "telnyx/resources/dir/verify_email"
 require_relative "telnyx/resources/document_links"
 require_relative "telnyx/resources/documents"
 require_relative "telnyx/resources/dynamic_emergency_addresses"
@@ -2804,6 +2831,8 @@ require_relative "telnyx/resources/storage"
 require_relative "telnyx/resources/storage/buckets"
 require_relative "telnyx/resources/storage/buckets/ssl_certificate"
 require_relative "telnyx/resources/storage/buckets/usage"
+require_relative "telnyx/resources/storage/kvs"
+require_relative "telnyx/resources/storage/kvs/keys"
 require_relative "telnyx/resources/storage/migrations"
 require_relative "telnyx/resources/storage/migrations/actions"
 require_relative "telnyx/resources/storage/migration_sources"
@@ -2871,6 +2900,4 @@ require_relative "telnyx/resources/wireless_blocklist_values"
 require_relative "telnyx/resources/x402"
 require_relative "telnyx/resources/x402/credit_account"
 
-# Custom lib entry point — preserved across codegen.
-# If this line is lost after a Stainless codegen run, it must be re-added.
 require_relative "telnyx/lib"