telnyx 5.160.0 → 5.161.0

data/rbi/telnyx/models/storage/sql_database.rbi

@@ -0,0 +1,131 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class SqlDatabase < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Storage::SqlDatabase, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :record_type
+
+        sig { params(record_type: String).void }
+        attr_writer :record_type
+
+        # Provisioning status. A database is usable once `status` is `provision_ok`. Once
+        # deletion completes, the database no longer appears in the API.
+        sig do
+          returns(T.nilable(Telnyx::Storage::SqlDatabase::Status::TaggedSymbol))
+        end
+        attr_reader :status
+
+        sig do
+          params(status: Telnyx::Storage::SqlDatabase::Status::OrSymbol).void
+        end
+        attr_writer :status
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :updated_at
+
+        sig { params(updated_at: Time).void }
+        attr_writer :updated_at
+
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            name: String,
+            record_type: String,
+            status: Telnyx::Storage::SqlDatabase::Status::OrSymbol,
+            updated_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id: nil,
+          created_at: nil,
+          name: nil,
+          record_type: nil,
+          # Provisioning status. A database is usable once `status` is `provision_ok`. Once
+          # deletion completes, the database no longer appears in the API.
+          status: nil,
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              name: String,
+              record_type: String,
+              status: Telnyx::Storage::SqlDatabase::Status::TaggedSymbol,
+              updated_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Provisioning status. A database is usable once `status` is `provision_ok`. Once
+        # deletion completes, the database no longer appears in the API.
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Telnyx::Storage::SqlDatabase::Status) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(:pending, Telnyx::Storage::SqlDatabase::Status::TaggedSymbol)
+          PROVISION_OK =
+            T.let(
+              :provision_ok,
+              Telnyx::Storage::SqlDatabase::Status::TaggedSymbol
+            )
+          PROVISION_FAILED =
+            T.let(
+              :provision_failed,
+              Telnyx::Storage::SqlDatabase::Status::TaggedSymbol
+            )
+          DELETING =
+            T.let(:deleting, Telnyx::Storage::SqlDatabase::Status::TaggedSymbol)
+          DELETE_FAILED =
+            T.let(
+              :delete_failed,
+              Telnyx::Storage::SqlDatabase::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::Storage::SqlDatabase::Status::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/sql_database_response_wrapper.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class SqlDatabaseResponseWrapper < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Storage::SqlDatabaseResponseWrapper,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(Telnyx::Storage::SqlDatabase)) }
+        attr_reader :data
+
+        sig { params(data: Telnyx::Storage::SqlDatabase::OrHash).void }
+        attr_writer :data
+
+        sig do
+          params(data: Telnyx::Storage::SqlDatabase::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(data: nil)
+        end
+
+        sig { override.returns({ data: Telnyx::Storage::SqlDatabase }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/sqldb_create_params.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class SqldbCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Storage::SqldbCreateParams, Telnyx::Internal::AnyHash)
+          end
+
+        # Database name. Lowercase letters, numbers, and hyphens only; must start and end
+        # with a letter or number.
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig do
+          params(
+            name: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Database name. Lowercase letters, numbers, and hyphens only; must start and end
+          # with a letter or number.
+          name:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { name: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/sqldb_delete_params.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class SqldbDeleteParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Storage::SqldbDeleteParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Delete the database even when functions still bind it. Their bindings stop
+        # resolving.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :force
+
+        sig { params(force: T::Boolean).void }
+        attr_writer :force
+
+        sig do
+          params(
+            id: String,
+            force: T::Boolean,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # Delete the database even when functions still bind it. Their bindings stop
+          # resolving.
+          force: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              force: T::Boolean,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/sqldb_list_params.rbi

@@ -0,0 +1,198 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class SqldbListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Storage::SqldbListParams, Telnyx::Internal::AnyHash)
+          end
+
+        # Filter by exact name match.
+        sig { returns(T.nilable(String)) }
+        attr_reader :filter_name
+
+        sig { params(filter_name: String).void }
+        attr_writer :filter_name
+
+        # Filter by provisioning status.
+        sig do
+          returns(
+            T.nilable(Telnyx::Storage::SqldbListParams::FilterStatus::OrSymbol)
+          )
+        end
+        attr_reader :filter_status
+
+        sig do
+          params(
+            filter_status:
+              Telnyx::Storage::SqldbListParams::FilterStatus::OrSymbol
+          ).void
+        end
+        attr_writer :filter_status
+
+        # The page number to load.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # The size of the page. Values above 250 are treated as 250.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        # Sort field; prefix with `-` for descending order.
+        sig do
+          returns(T.nilable(Telnyx::Storage::SqldbListParams::Sort::OrSymbol))
+        end
+        attr_reader :sort
+
+        sig do
+          params(sort: Telnyx::Storage::SqldbListParams::Sort::OrSymbol).void
+        end
+        attr_writer :sort
+
+        sig do
+          params(
+            filter_name: String,
+            filter_status:
+              Telnyx::Storage::SqldbListParams::FilterStatus::OrSymbol,
+            page_number: Integer,
+            page_size: Integer,
+            sort: Telnyx::Storage::SqldbListParams::Sort::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter by exact name match.
+          filter_name: nil,
+          # Filter by provisioning status.
+          filter_status: nil,
+          # The page number to load.
+          page_number: nil,
+          # The size of the page. Values above 250 are treated as 250.
+          page_size: nil,
+          # Sort field; prefix with `-` for descending order.
+          sort: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              filter_name: String,
+              filter_status:
+                Telnyx::Storage::SqldbListParams::FilterStatus::OrSymbol,
+              page_number: Integer,
+              page_size: Integer,
+              sort: Telnyx::Storage::SqldbListParams::Sort::OrSymbol,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Filter by provisioning status.
+        module FilterStatus
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Storage::SqldbListParams::FilterStatus)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :pending,
+              Telnyx::Storage::SqldbListParams::FilterStatus::TaggedSymbol
+            )
+          PROVISION_OK =
+            T.let(
+              :provision_ok,
+              Telnyx::Storage::SqldbListParams::FilterStatus::TaggedSymbol
+            )
+          PROVISION_FAILED =
+            T.let(
+              :provision_failed,
+              Telnyx::Storage::SqldbListParams::FilterStatus::TaggedSymbol
+            )
+          DELETING =
+            T.let(
+              :deleting,
+              Telnyx::Storage::SqldbListParams::FilterStatus::TaggedSymbol
+            )
+          DELETE_FAILED =
+            T.let(
+              :delete_failed,
+              Telnyx::Storage::SqldbListParams::FilterStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Storage::SqldbListParams::FilterStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Sort field; prefix with `-` for descending order.
+        module Sort
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Storage::SqldbListParams::Sort)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          NAME =
+            T.let(:name, Telnyx::Storage::SqldbListParams::Sort::TaggedSymbol)
+          NAME_DESC =
+            T.let(
+              :"-name",
+              Telnyx::Storage::SqldbListParams::Sort::TaggedSymbol
+            )
+          STATUS =
+            T.let(:status, Telnyx::Storage::SqldbListParams::Sort::TaggedSymbol)
+          STATUS_DESC =
+            T.let(
+              :"-status",
+              Telnyx::Storage::SqldbListParams::Sort::TaggedSymbol
+            )
+          CREATED_AT =
+            T.let(
+              :created_at,
+              Telnyx::Storage::SqldbListParams::Sort::TaggedSymbol
+            )
+          CREATED_AT_DESC =
+            T.let(
+              :"-created_at",
+              Telnyx::Storage::SqldbListParams::Sort::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::Storage::SqldbListParams::Sort::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/sqldb_retrieve_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      class SqldbRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Storage::SqldbRetrieveParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { id: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/storage/sqldbs/action_query_params.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Storage
+      module Sqldbs
+        class ActionQueryParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Storage::Sqldbs::ActionQueryParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The SQL to run. Use positional `?` placeholders and supply the values in
+          # `params` rather than interpolating them into this string.
+          sig { returns(String) }
+          attr_accessor :sql
+
+          # Positional bind parameters, in placeholder order. Each value is a string, a
+          # number, a boolean, or null; booleans are cast to `1`/`0`. The count must match
+          # the number of `?` placeholders exactly — a mismatch is rejected with 422 rather
+          # than binding null for the ones you left out. (Not enforced for multi-statement
+          # scripts or named parameters, where the placeholder count is not the number
+          # bound.)
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  T.nilable(
+                    Telnyx::Storage::Sqldbs::ActionQueryParams::Param::Variants
+                  )
+                ]
+              )
+            )
+          end
+          attr_reader :params
+
+          sig do
+            params(
+              params:
+                T::Array[
+                  T.nilable(
+                    Telnyx::Storage::Sqldbs::ActionQueryParams::Param::Variants
+                  )
+                ]
+            ).void
+          end
+          attr_writer :params
+
+          sig do
+            params(
+              id: String,
+              sql: String,
+              params:
+                T::Array[
+                  T.nilable(
+                    Telnyx::Storage::Sqldbs::ActionQueryParams::Param::Variants
+                  )
+                ],
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            # The SQL to run. Use positional `?` placeholders and supply the values in
+            # `params` rather than interpolating them into this string.
+            sql:,
+            # Positional bind parameters, in placeholder order. Each value is a string, a
+            # number, a boolean, or null; booleans are cast to `1`/`0`. The count must match
+            # the number of `?` placeholders exactly — a mismatch is rejected with 422 rather
+            # than binding null for the ones you left out. (Not enforced for multi-statement
+            # scripts or named parameters, where the placeholder count is not the number
+            # bound.)
+            params: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                sql: String,
+                params:
+                  T::Array[
+                    T.nilable(
+                      Telnyx::Storage::Sqldbs::ActionQueryParams::Param::Variants
+                    )
+                  ],
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Param
+            extend Telnyx::Internal::Type::Union
+
+            Variants =
+              T.type_alias { T.nilable(T.any(String, Float, T::Boolean)) }
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Storage::Sqldbs::ActionQueryParams::Param::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+        end
+      end
+    end
+  end
+end