telnyx 5.158.0 → 5.160.0

data/rbi/telnyx/models/email_messages/recipient_list_response.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module EmailMessages
+      class RecipientListResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::EmailMessages::RecipientListResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Array[Telnyx::EmailMessages::EmailRecipient]) }
+        attr_accessor :data
+
+        sig do
+          returns(Telnyx::Models::EmailMessages::RecipientListResponse::Meta)
+        end
+        attr_reader :meta
+
+        sig do
+          params(
+            meta:
+              Telnyx::Models::EmailMessages::RecipientListResponse::Meta::OrHash
+          ).void
+        end
+        attr_writer :meta
+
+        sig do
+          params(
+            data: T::Array[Telnyx::EmailMessages::EmailRecipient::OrHash],
+            meta:
+              Telnyx::Models::EmailMessages::RecipientListResponse::Meta::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data:, meta:)
+        end
+
+        sig do
+          override.returns(
+            {
+              data: T::Array[Telnyx::EmailMessages::EmailRecipient],
+              meta: Telnyx::Models::EmailMessages::RecipientListResponse::Meta
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Meta < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::EmailMessages::RecipientListResponse::Meta,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Integer) }
+          attr_accessor :page_size
+
+          # Cursor for the next page. Absent when there are no more results.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :page_cursor
+
+          sig do
+            params(page_size: Integer, page_cursor: T.nilable(String)).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            page_size:,
+            # Cursor for the next page. Absent when there are no more results.
+            page_cursor: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { page_size: Integer, page_cursor: T.nilable(String) }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_messages/recipient_retrieve_params.rbi

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

data/rbi/telnyx/models/email_messages/recipient_retrieve_response.rbi

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

data/rbi/telnyx/models/email_template.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailTemplate < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Telnyx::EmailTemplate, Telnyx::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :html_body
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(Telnyx::EmailTemplate::RecordType::TaggedSymbol) }
+      attr_accessor :record_type
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :subject
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :text_body
+
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      sig { returns(T::Array[String]) }
+      attr_accessor :variables
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          html_body: T.nilable(String),
+          name: String,
+          record_type: Telnyx::EmailTemplate::RecordType::OrSymbol,
+          subject: T.nilable(String),
+          text_body: T.nilable(String),
+          updated_at: Time,
+          variables: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        created_at:,
+        html_body:,
+        name:,
+        record_type:,
+        subject:,
+        text_body:,
+        updated_at:,
+        variables:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            html_body: T.nilable(String),
+            name: String,
+            record_type: Telnyx::EmailTemplate::RecordType::TaggedSymbol,
+            subject: T.nilable(String),
+            text_body: T.nilable(String),
+            updated_at: Time,
+            variables: T::Array[String]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::EmailTemplate::RecordType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EMAIL_TEMPLATE =
+          T.let(
+            :email_template,
+            Telnyx::EmailTemplate::RecordType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::EmailTemplate::RecordType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_template_create_params.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailTemplateCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::EmailTemplateCreateParams, Telnyx::Internal::AnyHash)
+        end
+
+      # Letters, numbers, spaces, hyphens, and underscores only.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Liquid template HTML body.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :html_body
+
+      # Liquid template subject.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :subject
+
+      # Liquid template text body.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :text_body
+
+      # Template variables. Auto-extracted from subject/body fields when absent.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :variables
+
+      sig { params(variables: T::Array[String]).void }
+      attr_writer :variables
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig do
+        params(
+          name: String,
+          html_body: T.nilable(String),
+          subject: T.nilable(String),
+          text_body: T.nilable(String),
+          variables: T::Array[String],
+          idempotency_key: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Letters, numbers, spaces, hyphens, and underscores only.
+        name:,
+        # Liquid template HTML body.
+        html_body: nil,
+        # Liquid template subject.
+        subject: nil,
+        # Liquid template text body.
+        text_body: nil,
+        # Template variables. Auto-extracted from subject/body fields when absent.
+        variables: nil,
+        idempotency_key: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            html_body: T.nilable(String),
+            subject: T.nilable(String),
+            text_body: T.nilable(String),
+            variables: T::Array[String],
+            idempotency_key: String,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_template_delete_params.rbi

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

data/rbi/telnyx/models/email_template_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailTemplateListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::EmailTemplateListParams, Telnyx::Internal::AnyHash)
+        end
+
+      # Opaque URL-safe Base64 cursor returned by a previous list response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :page_cursor
+
+      sig { params(page_cursor: String).void }
+      attr_writer :page_cursor
+
+      # Number of results to return. Defaults to 25; maximum is 100. Invalid values are
+      # clamped to the valid range.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      sig do
+        params(
+          page_cursor: String,
+          page_size: Integer,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Opaque URL-safe Base64 cursor returned by a previous list response.
+        page_cursor: nil,
+        # Number of results to return. Defaults to 25; maximum is 100. Invalid values are
+        # clamped to the valid range.
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            page_cursor: String,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_template_list_response.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailTemplateListResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::EmailTemplateListResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[Telnyx::EmailTemplate]) }
+      attr_accessor :data
+
+      sig { returns(Telnyx::EmailInboxes::EmailPaginationMeta) }
+      attr_reader :meta
+
+      sig do
+        params(meta: Telnyx::EmailInboxes::EmailPaginationMeta::OrHash).void
+      end
+      attr_writer :meta
+
+      sig do
+        params(
+          data: T::Array[Telnyx::EmailTemplate::OrHash],
+          meta: Telnyx::EmailInboxes::EmailPaginationMeta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:, meta:)
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T::Array[Telnyx::EmailTemplate],
+            meta: Telnyx::EmailInboxes::EmailPaginationMeta
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_template_render_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailTemplateRenderParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::EmailTemplateRenderParams, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Variables for Liquid template rendering. Non-object values are silently treated
+      # as an empty object.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :template_variables
+
+      sig { params(template_variables: T::Hash[Symbol, T.anything]).void }
+      attr_writer :template_variables
+
+      sig do
+        params(
+          id: String,
+          template_variables: T::Hash[Symbol, T.anything],
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Variables for Liquid template rendering. Non-object values are silently treated
+        # as an empty object.
+        template_variables: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            template_variables: T::Hash[Symbol, T.anything],
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_template_render_response.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailTemplateRenderResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::EmailTemplateRenderResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # Template object with `subject`, `html_body`, and `text_body` replaced by their
+      # Liquid-rendered values. All other template fields (id, name, variables, etc.)
+      # remain unchanged.
+      sig { returns(Telnyx::Models::EmailTemplateRenderResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: Telnyx::Models::EmailTemplateRenderResponse::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data: Telnyx::Models::EmailTemplateRenderResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Template object with `subject`, `html_body`, and `text_body` replaced by their
+        # Liquid-rendered values. All other template fields (id, name, variables, etc.)
+        # remain unchanged.
+        data:
+      )
+      end
+
+      sig do
+        override.returns(
+          { data: Telnyx::Models::EmailTemplateRenderResponse::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Models::EmailTemplate
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::EmailTemplateRenderResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Template object with `subject`, `html_body`, and `text_body` replaced by their
+        # Liquid-rendered values. All other template fields (id, name, variables, etc.)
+        # remain unchanged.
+        sig { returns(T.attached_class) }
+        def self.new
+        end
+
+        sig { override.returns({}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_template_replace_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class EmailTemplateReplaceParams < Telnyx::Models::UpdateEmailTemplateRequest
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::EmailTemplateReplaceParams, 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

data/rbi/telnyx/models/email_template_response.rbi

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