telnyx 5.151.0 → 5.153.0

data/rbi/telnyx/resources/storage/kvs.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class Storage
+      # Manage KV storage namespaces
+      class Kvs
+        # Read and write keys within a KV namespace
+        sig { returns(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`.
+        sig do
+          params(
+            name: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Storage::KvNamespaceResponseWrapper)
+        end
+        def create(
+          # Namespace name. May contain lowercase letters, numbers, and hyphens only.
+          name:,
+          request_options: {}
+        )
+        end
+
+        # Retrieves a KV namespace by its ID, including its provisioning status.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Storage::KvNamespaceResponseWrapper)
+        end
+        def retrieve(
+          # KV namespace ID
+          id,
+          request_options: {}
+        )
+        end
+
+        # Lists the KV namespaces for the authenticated user's organization. Results use
+        # page-based pagination (`page[number]`/`page[size]`).
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Internal::DefaultFlatPagination[
+              Telnyx::Storage::KvNamespace
+            ]
+          )
+        end
+        def list(
+          # The page number to load.
+          page_number: nil,
+          # The size of the page. Values above 250 are treated as 250.
+          page_size: nil,
+          request_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`.
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Storage::KvNamespaceResponseWrapper)
+        end
+        def delete(
+          # KV namespace ID
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/storage.rbi

@@ -16,6 +16,10 @@ module Telnyx
       sig { returns(Telnyx::Resources::Storage::Migrations) }
       attr_reader :migrations
 
+      # Manage KV storage namespaces
+      sig { returns(Telnyx::Resources::Storage::Kvs) }
+      attr_reader :kvs
+
       # List Migration Source coverage
       sig do
         params(request_options: Telnyx::RequestOptions::OrHash).returns(

data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi

@@ -61,6 +61,27 @@ 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.
+        sig do
+          params(
+            phone_number: String,
+            destination_number: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::Whatsapp::PhoneNumberRetrieveConversationWindowResponse
+          )
+        end
+        def retrieve_conversation_window(
+          # Phone number (E.164 format)
+          phone_number,
+          # Destination phone number in E.164 format
+          destination_number:,
+          request_options: {}
+        )
+        end
+
         # Submit verification code for a phone number
         sig do
           params(

data/sig/telnyx/internal/cursor_flat_pagination.rbs

@@ -0,0 +1,28 @@
+module Telnyx
+  module Internal
+    class CursorFlatPagination[Elem]
+      include Telnyx::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: ::Array[Elem]?
+
+      attr_accessor meta: Meta
+
+      def inspect: -> String
+
+      type meta = { cursor: String, has_more: bool }
+      class Meta < Telnyx::Internal::Type::BaseModel
+        attr_reader cursor: String?
+
+        def cursor=: (String) -> String
+
+        attr_reader has_more: bool?
+
+        def has_more=: (bool) -> bool
+
+        def initialize: (?cursor: String, ?has_more: bool) -> void
+
+        def to_hash: -> { cursor: String, has_more: bool }
+      end
+    end
+  end
+end

data/sig/telnyx/models/advanced_order_create_params.rbs

@@ -1,111 +1,15 @@
 module Telnyx
   module Models
     type advanced_order_create_params =
-      {
-        area_code: String,
-        comments: String,
-        country_code: String,
-        customer_reference: String,
-        features: ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature],
-        phone_number_type: Telnyx::Models::AdvancedOrderCreateParams::phone_number_type,
-        quantity: Integer,
-        requirement_group_id: String
-      }
-      & Telnyx::Internal::Type::request_parameters
+      {  } & Telnyx::Internal::Type::request_parameters
 
     class AdvancedOrderCreateParams < Telnyx::Models::AdvancedOrderRequest
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
-      attr_reader area_code: String?
+      def initialize: (?request_options: Telnyx::request_opts) -> void
 
-      def area_code=: (String) -> String
-
-      attr_reader comments: String?
-
-      def comments=: (String) -> String
-
-      attr_reader country_code: String?
-
-      def country_code=: (String) -> String
-
-      attr_reader customer_reference: String?
-
-      def customer_reference=: (String) -> String
-
-      attr_reader features: ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature]?
-
-      def features=: (
-        ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature]
-      ) -> ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature]
-
-      attr_reader phone_number_type: Telnyx::Models::AdvancedOrderCreateParams::phone_number_type?
-
-      def phone_number_type=: (
-        Telnyx::Models::AdvancedOrderCreateParams::phone_number_type
-      ) -> Telnyx::Models::AdvancedOrderCreateParams::phone_number_type
-
-      attr_reader quantity: Integer?
-
-      def quantity=: (Integer) -> Integer
-
-      attr_reader requirement_group_id: String?
-
-      def requirement_group_id=: (String) -> String
-
-      def initialize: (
-        ?area_code: String,
-        ?comments: String,
-        ?country_code: String,
-        ?customer_reference: String,
-        ?features: ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature],
-        ?phone_number_type: Telnyx::Models::AdvancedOrderCreateParams::phone_number_type,
-        ?quantity: Integer,
-        ?requirement_group_id: String,
-        ?request_options: Telnyx::request_opts
-      ) -> void
-
-      def to_hash: -> {
-        area_code: String,
-        comments: String,
-        country_code: String,
-        customer_reference: String,
-        features: ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature],
-        phone_number_type: Telnyx::Models::AdvancedOrderCreateParams::phone_number_type,
-        quantity: Integer,
-        requirement_group_id: String,
-        request_options: Telnyx::RequestOptions
-      }
-
-      type feature = :sms | :mms | :voice | :fax | :emergency
-
-      module Feature
-        extend Telnyx::Internal::Type::Enum
-
-        SMS: :sms
-        MMS: :mms
-        VOICE: :voice
-        FAX: :fax
-        EMERGENCY: :emergency
-
-        def self?.values: -> ::Array[Telnyx::Models::AdvancedOrderCreateParams::feature]
-      end
-
-      type phone_number_type =
-        :local | :mobile | :toll_free | :shared_cost | :national | :landline
-
-      module PhoneNumberType
-        extend Telnyx::Internal::Type::Enum
-
-        LOCAL: :local
-        MOBILE: :mobile
-        TOLL_FREE: :toll_free
-        SHARED_COST: :shared_cost
-        NATIONAL: :national
-        LANDLINE: :landline
-
-        def self?.values: -> ::Array[Telnyx::Models::AdvancedOrderCreateParams::phone_number_type]
-      end
+      def to_hash: -> { request_options: Telnyx::RequestOptions }
     end
   end
 end

data/sig/telnyx/models/advanced_order_update_requirement_group_params.rbs

@@ -1,116 +1,25 @@
 module Telnyx
   module Models
     type advanced_order_update_requirement_group_params =
-      {
-        advanced_order_id: String,
-        area_code: String,
-        comments: String,
-        country_code: String,
-        customer_reference: String,
-        features: ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::feature],
-        phone_number_type: Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::phone_number_type,
-        quantity: Integer,
-        requirement_group_id: String
-      }
-      & Telnyx::Internal::Type::request_parameters
+      { advanced_order_id: String } & Telnyx::Internal::Type::request_parameters
 
     class AdvancedOrderUpdateRequirementGroupParams < Telnyx::Models::AdvancedOrderRequest
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
-      attr_accessor advanced_order_id: String
-
-      attr_reader area_code: String?
-
-      def area_code=: (String) -> String
-
-      attr_reader comments: String?
-
-      def comments=: (String) -> String
-
-      attr_reader country_code: String?
-
-      def country_code=: (String) -> String
-
-      attr_reader customer_reference: String?
-
-      def customer_reference=: (String) -> String
-
-      attr_reader features: ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::feature]?
-
-      def features=: (
-        ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::feature]
-      ) -> ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::feature]
-
-      attr_reader phone_number_type: Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::phone_number_type?
+      def advanced_order_id: -> String
 
-      def phone_number_type=: (
-        Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::phone_number_type
-      ) -> Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::phone_number_type
-
-      attr_reader quantity: Integer?
-
-      def quantity=: (Integer) -> Integer
-
-      attr_reader requirement_group_id: String?
-
-      def requirement_group_id=: (String) -> String
+      def advanced_order_id=: (String _) -> String
 
       def initialize: (
         advanced_order_id: String,
-        ?area_code: String,
-        ?comments: String,
-        ?country_code: String,
-        ?customer_reference: String,
-        ?features: ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::feature],
-        ?phone_number_type: Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::phone_number_type,
-        ?quantity: Integer,
-        ?requirement_group_id: String,
         ?request_options: Telnyx::request_opts
       ) -> void
 
       def to_hash: -> {
         advanced_order_id: String,
-        area_code: String,
-        comments: String,
-        country_code: String,
-        customer_reference: String,
-        features: ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::feature],
-        phone_number_type: Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::phone_number_type,
-        quantity: Integer,
-        requirement_group_id: String,
         request_options: Telnyx::RequestOptions
       }
-
-      type feature = :sms | :mms | :voice | :fax | :emergency
-
-      module Feature
-        extend Telnyx::Internal::Type::Enum
-
-        SMS: :sms
-        MMS: :mms
-        VOICE: :voice
-        FAX: :fax
-        EMERGENCY: :emergency
-
-        def self?.values: -> ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::feature]
-      end
-
-      type phone_number_type =
-        :local | :mobile | :toll_free | :shared_cost | :national | :landline
-
-      module PhoneNumberType
-        extend Telnyx::Internal::Type::Enum
-
-        LOCAL: :local
-        MOBILE: :mobile
-        TOLL_FREE: :toll_free
-        SHARED_COST: :shared_cost
-        NATIONAL: :national
-        LANDLINE: :landline
-
-        def self?.values: -> ::Array[Telnyx::Models::AdvancedOrderUpdateRequirementGroupParams::phone_number_type]
-      end
     end
   end
 end

data/sig/telnyx/models/dir/email_verification_status_wrapped.rbs

@@ -0,0 +1,69 @@
+module Telnyx
+  module Models
+    module Dir
+      type email_verification_status_wrapped =
+        { data: Telnyx::Dir::EmailVerificationStatusWrapped::Data }
+
+      class EmailVerificationStatusWrapped < Telnyx::Internal::Type::BaseModel
+        attr_accessor data: Telnyx::Dir::EmailVerificationStatusWrapped::Data
+
+        def initialize: (
+          data: Telnyx::Dir::EmailVerificationStatusWrapped::Data
+        ) -> void
+
+        def to_hash: -> {
+          data: Telnyx::Dir::EmailVerificationStatusWrapped::Data
+        }
+
+        type data =
+          {
+            email_verified: bool,
+            record_type: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::record_type,
+            status: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::status
+          }
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          attr_accessor email_verified: bool
+
+          attr_accessor status: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::status
+
+          attr_accessor record_type: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::record_type
+
+          def initialize: (
+            email_verified: bool,
+            record_type: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::record_type,
+            status: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::status
+          ) -> void
+
+          def to_hash: -> {
+            email_verified: bool,
+            record_type: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::record_type,
+            status: Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::status
+          }
+
+          type record_type = :email_verification
+
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            EMAIL_VERIFICATION: :email_verification
+
+            def self?.values: -> ::Array[Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::record_type]
+          end
+
+          type status = :sent | :verified | :unverified
+
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            SENT: :sent
+            VERIFIED: :verified
+            UNVERIFIED: :unverified
+
+            def self?.values: -> ::Array[Telnyx::Models::Dir::EmailVerificationStatusWrapped::Data::status]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/dir/reference.rbs

@@ -0,0 +1,88 @@
+module Telnyx
+  module Models
+    module Dir
+      type reference =
+        {
+          full_name: String,
+          :phone_e164 => String,
+          record_type: Telnyx::Models::Dir::Reference::record_type,
+          ref_type: Telnyx::Models::Dir::Reference::ref_type,
+          slot: Integer,
+          timezone: String,
+          email: String?,
+          job_title: String?,
+          organization: String?,
+          relationship_to_registrant: String?
+        }
+
+      class Reference < Telnyx::Internal::Type::BaseModel
+        attr_accessor full_name: String
+
+        attr_accessor phone_e164: String
+
+        attr_accessor ref_type: Telnyx::Models::Dir::Reference::ref_type
+
+        attr_accessor slot: Integer
+
+        attr_accessor timezone: String
+
+        attr_accessor email: String?
+
+        attr_accessor job_title: String?
+
+        attr_accessor organization: String?
+
+        attr_accessor relationship_to_registrant: String?
+
+        attr_accessor record_type: Telnyx::Models::Dir::Reference::record_type
+
+        def initialize: (
+          full_name: String,
+          phone_e164: String,
+          record_type: Telnyx::Models::Dir::Reference::record_type,
+          ref_type: Telnyx::Models::Dir::Reference::ref_type,
+          slot: Integer,
+          timezone: String,
+          ?email: String?,
+          ?job_title: String?,
+          ?organization: String?,
+          ?relationship_to_registrant: String?
+        ) -> void
+
+        def to_hash: -> {
+          full_name: String,
+          :phone_e164 => String,
+          record_type: Telnyx::Models::Dir::Reference::record_type,
+          ref_type: Telnyx::Models::Dir::Reference::ref_type,
+          slot: Integer,
+          timezone: String,
+          email: String?,
+          job_title: String?,
+          organization: String?,
+          relationship_to_registrant: String?
+        }
+
+        type record_type = :dir_reference
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          DIR_REFERENCE: :dir_reference
+
+          def self?.values: -> ::Array[Telnyx::Models::Dir::Reference::record_type]
+        end
+
+        type ref_type = :business | :financial
+
+        module RefType
+          extend Telnyx::Internal::Type::Enum
+
+          BUSINESS: :business
+          FINANCIAL: :financial
+
+          def self?.values: -> ::Array[Telnyx::Models::Dir::Reference::ref_type]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/dir/reference_create_params.rbs

@@ -0,0 +1,38 @@
+module Telnyx
+  module Models
+    module Dir
+      type reference_create_params =
+        {
+          dir_id: String,
+          business_references: ::Array[Telnyx::Dir::ReferenceInput],
+          financial_reference: Telnyx::Dir::ReferenceInput
+        }
+        & Telnyx::Internal::Type::request_parameters
+
+      class ReferenceCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor dir_id: String
+
+        attr_accessor business_references: ::Array[Telnyx::Dir::ReferenceInput]
+
+        attr_accessor financial_reference: Telnyx::Dir::ReferenceInput
+
+        def initialize: (
+          dir_id: String,
+          business_references: ::Array[Telnyx::Dir::ReferenceInput],
+          financial_reference: Telnyx::Dir::ReferenceInput,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          dir_id: String,
+          business_references: ::Array[Telnyx::Dir::ReferenceInput],
+          financial_reference: Telnyx::Dir::ReferenceInput,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/dir/reference_input.rbs

@@ -0,0 +1,52 @@
+module Telnyx
+  module Models
+    module Dir
+      type reference_input =
+        {
+          email: String,
+          full_name: String,
+          :phone_e164 => String,
+          timezone: String,
+          job_title: String?,
+          organization: String?,
+          relationship_to_registrant: String?
+        }
+
+      class ReferenceInput < Telnyx::Internal::Type::BaseModel
+        attr_accessor email: String
+
+        attr_accessor full_name: String
+
+        attr_accessor phone_e164: String
+
+        attr_accessor timezone: String
+
+        attr_accessor job_title: String?
+
+        attr_accessor organization: String?
+
+        attr_accessor relationship_to_registrant: String?
+
+        def initialize: (
+          email: String,
+          full_name: String,
+          phone_e164: String,
+          timezone: String,
+          ?job_title: String?,
+          ?organization: String?,
+          ?relationship_to_registrant: String?
+        ) -> void
+
+        def to_hash: -> {
+          email: String,
+          full_name: String,
+          :phone_e164 => String,
+          timezone: String,
+          job_title: String?,
+          organization: String?,
+          relationship_to_registrant: String?
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/dir/reference_list.rbs

@@ -0,0 +1,15 @@
+module Telnyx
+  module Models
+    module Dir
+      type reference_list = { data: ::Array[Telnyx::Dir::Reference] }
+
+      class ReferenceList < Telnyx::Internal::Type::BaseModel
+        attr_accessor data: ::Array[Telnyx::Dir::Reference]
+
+        def initialize: (data: ::Array[Telnyx::Dir::Reference]) -> void
+
+        def to_hash: -> { data: ::Array[Telnyx::Dir::Reference] }
+      end
+    end
+  end
+end

data/sig/telnyx/models/dir/reference_list_params.rbs

@@ -0,0 +1,25 @@
+module Telnyx
+  module Models
+    module Dir
+      type reference_list_params =
+        { dir_id: String } & Telnyx::Internal::Type::request_parameters
+
+      class ReferenceListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor dir_id: String
+
+        def initialize: (
+          dir_id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          dir_id: String,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end