telnyx 5.171.0 → 5.173.0

data/rbi/telnyx/models/email/dedicated_ip_create_params.rbi

@@ -0,0 +1,149 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Email
+      class DedicatedIPCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Email::DedicatedIPCreateParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :idempotency_key
+
+        # Allocate an IP of this address family. Supported value: `ipv4`. Any other value,
+        # including `ipv6` or `null`, returns `422`.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Email::DedicatedIPCreateParams::IPVersion::OrSymbol
+            )
+          )
+        end
+        attr_reader :ip_version
+
+        sig do
+          params(
+            ip_version:
+              Telnyx::Email::DedicatedIPCreateParams::IPVersion::OrSymbol
+          ).void
+        end
+        attr_writer :ip_version
+
+        # Allocate an IP in this region. Supported value: `ewr-nj1`. Any other value,
+        # including an empty string or `null`, returns `422`.
+        sig do
+          returns(
+            T.nilable(Telnyx::Email::DedicatedIPCreateParams::Region::OrSymbol)
+          )
+        end
+        attr_reader :region
+
+        sig do
+          params(
+            region: Telnyx::Email::DedicatedIPCreateParams::Region::OrSymbol
+          ).void
+        end
+        attr_writer :region
+
+        sig do
+          params(
+            idempotency_key: String,
+            ip_version:
+              Telnyx::Email::DedicatedIPCreateParams::IPVersion::OrSymbol,
+            region: Telnyx::Email::DedicatedIPCreateParams::Region::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          idempotency_key:,
+          # Allocate an IP of this address family. Supported value: `ipv4`. Any other value,
+          # including `ipv6` or `null`, returns `422`.
+          ip_version: nil,
+          # Allocate an IP in this region. Supported value: `ewr-nj1`. Any other value,
+          # including an empty string or `null`, returns `422`.
+          region: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              idempotency_key: String,
+              ip_version:
+                Telnyx::Email::DedicatedIPCreateParams::IPVersion::OrSymbol,
+              region: Telnyx::Email::DedicatedIPCreateParams::Region::OrSymbol,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Allocate an IP of this address family. Supported value: `ipv4`. Any other value,
+        # including `ipv6` or `null`, returns `422`.
+        module IPVersion
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Email::DedicatedIPCreateParams::IPVersion)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IPV4 =
+            T.let(
+              :ipv4,
+              Telnyx::Email::DedicatedIPCreateParams::IPVersion::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Email::DedicatedIPCreateParams::IPVersion::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Allocate an IP in this region. Supported value: `ewr-nj1`. Any other value,
+        # including an empty string or `null`, returns `422`.
+        module Region
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Email::DedicatedIPCreateParams::Region)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EWR_NJ1 =
+            T.let(
+              :"ewr-nj1",
+              Telnyx::Email::DedicatedIPCreateParams::Region::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Email::DedicatedIPCreateParams::Region::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email/dedicated_ip_delete_params.rbi

@@ -0,0 +1,124 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Email
+      class DedicatedIPDeleteParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Email::DedicatedIPDeleteParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Set together with `force=true` to release the last IP in a pool. Acknowledges
+        # that mail routed to the emptied pool is held until the pool has a sendable IP
+        # again. Also accepted in the JSON body.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :query_drain
+
+        sig { params(query_drain: T::Boolean).void }
+        attr_writer :query_drain
+
+        # Set together with `drain=true` to release the last IP in a pool. Either flag
+        # alone has no effect. Also accepted in the JSON body.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :query_force
+
+        sig { params(query_force: T::Boolean).void }
+        attr_writer :query_force
+
+        # Free-text reason recorded with the release. Also accepted in the JSON body.
+        sig { returns(T.nilable(String)) }
+        attr_reader :query_reason
+
+        sig { params(query_reason: String).void }
+        attr_writer :query_reason
+
+        # Set together with `force: true` to release the last IP in a pool. Acknowledges
+        # that mail routed to the emptied pool is held until the pool has a sendable IP
+        # again.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :body_drain
+
+        sig { params(body_drain: T::Boolean).void }
+        attr_writer :body_drain
+
+        # Set together with `drain: true` to release the last IP in a pool. Either flag
+        # alone has no effect.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :body_force
+
+        sig { params(body_force: T::Boolean).void }
+        attr_writer :body_force
+
+        # Free-text reason recorded with the release.
+        sig { returns(T.nilable(String)) }
+        attr_reader :body_reason
+
+        sig { params(body_reason: String).void }
+        attr_writer :body_reason
+
+        sig do
+          params(
+            id: String,
+            query_drain: T::Boolean,
+            query_force: T::Boolean,
+            query_reason: String,
+            body_drain: T::Boolean,
+            body_force: T::Boolean,
+            body_reason: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # Set together with `force=true` to release the last IP in a pool. Acknowledges
+          # that mail routed to the emptied pool is held until the pool has a sendable IP
+          # again. Also accepted in the JSON body.
+          query_drain: nil,
+          # Set together with `drain=true` to release the last IP in a pool. Either flag
+          # alone has no effect. Also accepted in the JSON body.
+          query_force: nil,
+          # Free-text reason recorded with the release. Also accepted in the JSON body.
+          query_reason: nil,
+          # Set together with `force: true` to release the last IP in a pool. Acknowledges
+          # that mail routed to the emptied pool is held until the pool has a sendable IP
+          # again.
+          body_drain: nil,
+          # Set together with `drain: true` to release the last IP in a pool. Either flag
+          # alone has no effect.
+          body_force: nil,
+          # Free-text reason recorded with the release.
+          body_reason: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              query_drain: T::Boolean,
+              query_force: T::Boolean,
+              query_reason: String,
+              body_drain: T::Boolean,
+              body_force: T::Boolean,
+              body_reason: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email/dedicated_ip_list_params.rbi

@@ -0,0 +1,140 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Email
+      class DedicatedIPListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Email::DedicatedIPListParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Return only IPs in this pool (exact match on `pool_id`). A value that is not a
+        # UUID returns an empty list. An empty value applies no filter.
+        sig { returns(T.nilable(String)) }
+        attr_reader :filter_pool_id
+
+        sig { params(filter_pool_id: String).void }
+        attr_writer :filter_pool_id
+
+        # Return only IPs in this region (exact, case-sensitive match on `region`). An
+        # empty value applies no filter.
+        sig { returns(T.nilable(String)) }
+        attr_reader :filter_region
+
+        sig { params(filter_region: String).void }
+        attr_writer :filter_region
+
+        # Return only IPs in this lifecycle status (exact match). Any other value returns
+        # an empty list. An empty value applies no filter.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Email::DedicatedIPListParams::FilterStatus::OrSymbol
+            )
+          )
+        end
+        attr_reader :filter_status
+
+        sig do
+          params(
+            filter_status:
+              Telnyx::Email::DedicatedIPListParams::FilterStatus::OrSymbol
+          ).void
+        end
+        attr_writer :filter_status
+
+        sig do
+          params(
+            filter_pool_id: String,
+            filter_region: String,
+            filter_status:
+              Telnyx::Email::DedicatedIPListParams::FilterStatus::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Return only IPs in this pool (exact match on `pool_id`). A value that is not a
+          # UUID returns an empty list. An empty value applies no filter.
+          filter_pool_id: nil,
+          # Return only IPs in this region (exact, case-sensitive match on `region`). An
+          # empty value applies no filter.
+          filter_region: nil,
+          # Return only IPs in this lifecycle status (exact match). Any other value returns
+          # an empty list. An empty value applies no filter.
+          filter_status: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              filter_pool_id: String,
+              filter_region: String,
+              filter_status:
+                Telnyx::Email::DedicatedIPListParams::FilterStatus::OrSymbol,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Return only IPs in this lifecycle status (exact match). Any other value returns
+        # an empty list. An empty value applies no filter.
+        module FilterStatus
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Email::DedicatedIPListParams::FilterStatus)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PROVISIONING =
+            T.let(
+              :provisioning,
+              Telnyx::Email::DedicatedIPListParams::FilterStatus::TaggedSymbol
+            )
+          WARMING_UP =
+            T.let(
+              :warming_up,
+              Telnyx::Email::DedicatedIPListParams::FilterStatus::TaggedSymbol
+            )
+          ACTIVE =
+            T.let(
+              :active,
+              Telnyx::Email::DedicatedIPListParams::FilterStatus::TaggedSymbol
+            )
+          SUSPENDED =
+            T.let(
+              :suspended,
+              Telnyx::Email::DedicatedIPListParams::FilterStatus::TaggedSymbol
+            )
+          RELEASED =
+            T.let(
+              :released,
+              Telnyx::Email::DedicatedIPListParams::FilterStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Email::DedicatedIPListParams::FilterStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email/dedicated_ip_list_response.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Email
+      class DedicatedIPListResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Email::DedicatedIPListResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Array[Telnyx::Email::DedicatedIP]) }
+        attr_accessor :data
+
+        sig do
+          params(data: T::Array[Telnyx::Email::DedicatedIP::OrHash]).returns(
+            T.attached_class
+          )
+        end
+        def self.new(data:)
+        end
+
+        sig { override.returns({ data: T::Array[Telnyx::Email::DedicatedIP] }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email/dedicated_ip_retrieve_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Email
+      class DedicatedIPRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Email::DedicatedIPRetrieveParams,
+              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/email/dedicated_ip_show_response.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Email
+      class DedicatedIPShowResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Email::DedicatedIPShowResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # A dedicated sending IP address owned by the account.
+        sig { returns(Telnyx::Email::DedicatedIP) }
+        attr_reader :data
+
+        sig { params(data: Telnyx::Email::DedicatedIP::OrHash).void }
+        attr_writer :data
+
+        sig do
+          params(data: Telnyx::Email::DedicatedIP::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # A dedicated sending IP address owned by the account.
+          data:
+        )
+        end
+
+        sig { override.returns({ data: Telnyx::Email::DedicatedIP }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email/dedicated_ip_update_params.rbi

@@ -0,0 +1,165 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Email
+      class DedicatedIPUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Email::DedicatedIPUpdateParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Set together with `force: true` to move the last IP out of its current pool.
+        # Acknowledges that mail routed to the emptied pool is held. Used only with
+        # `pool_id`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :drain
+
+        sig { params(drain: T::Boolean).void }
+        attr_writer :drain
+
+        # Set together with `drain: true` to move the last IP out of its current pool.
+        # Used only with `pool_id`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :force
+
+        sig { params(force: T::Boolean).void }
+        attr_writer :force
+
+        # Move the IP to this pool, replacing its current membership. Use the IP's current
+        # pool to change only its weight. To take an IP out of a pool, use
+        # `DELETE /email/ip_pools/{id}/ips/{ip_id}`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :pool_id
+
+        sig { params(pool_id: String).void }
+        attr_writer :pool_id
+
+        # Alias for `warmup_paused`.
+        sig do
+          returns(T.nilable(Telnyx::Email::DedicatedIPUpdateParams::Warmup))
+        end
+        attr_reader :warmup
+
+        sig do
+          params(
+            warmup: Telnyx::Email::DedicatedIPUpdateParams::Warmup::OrHash
+          ).void
+        end
+        attr_writer :warmup
+
+        # Pause (`true`) or resume (`false`) the warm-up ramp; equivalent to the
+        # `pause_warmup` and `resume_warmup` actions. A Boolean value takes precedence
+        # over `warmup.paused`. When a pause field is present and `pool_id` is absent,
+        # supplying neither pause field as a Boolean invokes resume.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :warmup_paused
+
+        sig { params(warmup_paused: T::Boolean).void }
+        attr_writer :warmup_paused
+
+        # Routing weight in the target pool. Used only with `pool_id`.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :weight
+
+        sig { params(weight: Integer).void }
+        attr_writer :weight
+
+        sig do
+          params(
+            id: String,
+            drain: T::Boolean,
+            force: T::Boolean,
+            pool_id: String,
+            warmup: Telnyx::Email::DedicatedIPUpdateParams::Warmup::OrHash,
+            warmup_paused: T::Boolean,
+            weight: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # Set together with `force: true` to move the last IP out of its current pool.
+          # Acknowledges that mail routed to the emptied pool is held. Used only with
+          # `pool_id`.
+          drain: nil,
+          # Set together with `drain: true` to move the last IP out of its current pool.
+          # Used only with `pool_id`.
+          force: nil,
+          # Move the IP to this pool, replacing its current membership. Use the IP's current
+          # pool to change only its weight. To take an IP out of a pool, use
+          # `DELETE /email/ip_pools/{id}/ips/{ip_id}`.
+          pool_id: nil,
+          # Alias for `warmup_paused`.
+          warmup: nil,
+          # Pause (`true`) or resume (`false`) the warm-up ramp; equivalent to the
+          # `pause_warmup` and `resume_warmup` actions. A Boolean value takes precedence
+          # over `warmup.paused`. When a pause field is present and `pool_id` is absent,
+          # supplying neither pause field as a Boolean invokes resume.
+          warmup_paused: nil,
+          # Routing weight in the target pool. Used only with `pool_id`.
+          weight: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              drain: T::Boolean,
+              force: T::Boolean,
+              pool_id: String,
+              warmup: Telnyx::Email::DedicatedIPUpdateParams::Warmup,
+              warmup_paused: T::Boolean,
+              weight: Integer,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Warmup < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Email::DedicatedIPUpdateParams::Warmup,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Pause (`true`) or resume (`false`) the warm-up ramp. Used only when
+          # `warmup_paused` is not a Boolean.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :paused
+
+          sig { params(paused: T::Boolean).void }
+          attr_writer :paused
+
+          # Alias for `warmup_paused`.
+          sig { params(paused: T::Boolean).returns(T.attached_class) }
+          def self.new(
+            # Pause (`true`) or resume (`false`) the warm-up ramp. Used only when
+            # `warmup_paused` is not a Boolean.
+            paused: nil
+          )
+          end
+
+          sig { override.returns({ paused: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end