telnyx 5.158.0 → 5.159.0

data/sig/telnyx/models/email_message_retrieve_events_params.rbs

@@ -0,0 +1,36 @@
+module Telnyx
+  module Models
+    type email_message_retrieve_events_params =
+      { email_id: String, page_cursor: String, page_size: Integer }
+      & Telnyx::Internal::Type::request_parameters
+
+    class EmailMessageRetrieveEventsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor email_id: String
+
+      attr_reader page_cursor: String?
+
+      def page_cursor=: (String) -> String
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      def initialize: (
+        email_id: String,
+        ?page_cursor: String,
+        ?page_size: Integer,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        email_id: String,
+        page_cursor: String,
+        page_size: Integer,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_message_retrieve_events_response.rbs

@@ -0,0 +1,25 @@
+module Telnyx
+  module Models
+    type email_message_retrieve_events_response =
+      {
+        data: ::Array[Telnyx::MessageEvent],
+        meta: Telnyx::EmailInboxes::EmailPaginationMeta
+      }
+
+    class EmailMessageRetrieveEventsResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: ::Array[Telnyx::MessageEvent]
+
+      attr_accessor meta: Telnyx::EmailInboxes::EmailPaginationMeta
+
+      def initialize: (
+        data: ::Array[Telnyx::MessageEvent],
+        meta: Telnyx::EmailInboxes::EmailPaginationMeta
+      ) -> void
+
+      def to_hash: -> {
+        data: ::Array[Telnyx::MessageEvent],
+        meta: Telnyx::EmailInboxes::EmailPaginationMeta
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_message_retrieve_params.rbs

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

data/sig/telnyx/models/email_message_retrieve_response.rbs

@@ -0,0 +1,34 @@
+module Telnyx
+  module Models
+    type email_message_retrieve_response =
+      { data: Telnyx::Models::EmailMessageRetrieveResponse::Data }
+
+    class EmailMessageRetrieveResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: Telnyx::Models::EmailMessageRetrieveResponse::Data
+
+      def initialize: (
+        data: Telnyx::Models::EmailMessageRetrieveResponse::Data
+      ) -> void
+
+      def to_hash: -> {
+        data: Telnyx::Models::EmailMessageRetrieveResponse::Data
+      }
+
+      type data = { html_body: String?, text_body: String? }
+
+      class Data < Telnyx::Models::EmailInboxes::EmailMessage
+        def html_body: -> String?
+
+        def html_body=: (String? _) -> String?
+
+        def text_body: -> String?
+
+        def text_body=: (String? _) -> String?
+
+        def initialize: (html_body: String?, text_body: String?) -> void
+
+        def to_hash: -> { html_body: String?, text_body: String? }
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_messages/email_recipient.rbs

@@ -0,0 +1,126 @@
+module Telnyx
+  module Models
+    module EmailMessages
+      type email_recipient =
+        {
+          id: String,
+          address: String?,
+          billable: bool,
+          kind: Telnyx::Models::EmailMessages::EmailRecipient::kind,
+          message_id: String,
+          record_type: Telnyx::Models::EmailMessages::EmailRecipient::record_type,
+          status: Telnyx::Models::EmailMessages::EmailRecipient::status,
+          delivered_at: Time?,
+          failed_at: Time?,
+          sent_at: Time?,
+          smtp_code: Integer?,
+          smtp_response: String?
+        }
+
+      class EmailRecipient < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor address: String?
+
+        attr_accessor billable: bool
+
+        attr_accessor kind: Telnyx::Models::EmailMessages::EmailRecipient::kind
+
+        attr_accessor message_id: String
+
+        attr_accessor record_type: Telnyx::Models::EmailMessages::EmailRecipient::record_type
+
+        attr_accessor status: Telnyx::Models::EmailMessages::EmailRecipient::status
+
+        attr_accessor delivered_at: Time?
+
+        attr_accessor failed_at: Time?
+
+        attr_accessor sent_at: Time?
+
+        attr_accessor smtp_code: Integer?
+
+        attr_accessor smtp_response: String?
+
+        def initialize: (
+          id: String,
+          address: String?,
+          billable: bool,
+          kind: Telnyx::Models::EmailMessages::EmailRecipient::kind,
+          message_id: String,
+          record_type: Telnyx::Models::EmailMessages::EmailRecipient::record_type,
+          status: Telnyx::Models::EmailMessages::EmailRecipient::status,
+          ?delivered_at: Time?,
+          ?failed_at: Time?,
+          ?sent_at: Time?,
+          ?smtp_code: Integer?,
+          ?smtp_response: String?
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          address: String?,
+          billable: bool,
+          kind: Telnyx::Models::EmailMessages::EmailRecipient::kind,
+          message_id: String,
+          record_type: Telnyx::Models::EmailMessages::EmailRecipient::record_type,
+          status: Telnyx::Models::EmailMessages::EmailRecipient::status,
+          delivered_at: Time?,
+          failed_at: Time?,
+          sent_at: Time?,
+          smtp_code: Integer?,
+          smtp_response: String?
+        }
+
+        type kind = :to | :cc | :bcc
+
+        module Kind
+          extend Telnyx::Internal::Type::Enum
+
+          TO: :to
+          CC: :cc
+          BCC: :bcc
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailMessages::EmailRecipient::kind]
+        end
+
+        type record_type = :email_recipient
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_RECIPIENT: :email_recipient
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailMessages::EmailRecipient::record_type]
+        end
+
+        type status =
+          :queued
+          | :sending
+          | :sent
+          | :deferred
+          | :delivered
+          | :bounced
+          | :failed
+          | :gw_reject
+          | :cancelled
+
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          QUEUED: :queued
+          SENDING: :sending
+          SENT: :sent
+          DEFERRED: :deferred
+          DELIVERED: :delivered
+          BOUNCED: :bounced
+          FAILED: :failed
+          GW_REJECT: :gw_reject
+          CANCELLED: :cancelled
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailMessages::EmailRecipient::status]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_messages/recipient_list_params.rbs

@@ -0,0 +1,99 @@
+module Telnyx
+  module Models
+    module EmailMessages
+      type recipient_list_params =
+        {
+          email_id: String,
+          kind: Telnyx::Models::EmailMessages::RecipientListParams::kind,
+          page_cursor: String,
+          page_size: Integer,
+          status: Telnyx::Models::EmailMessages::RecipientListParams::status
+        }
+        & Telnyx::Internal::Type::request_parameters
+
+      class RecipientListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor email_id: String
+
+        attr_reader kind: Telnyx::Models::EmailMessages::RecipientListParams::kind?
+
+        def kind=: (
+          Telnyx::Models::EmailMessages::RecipientListParams::kind
+        ) -> Telnyx::Models::EmailMessages::RecipientListParams::kind
+
+        attr_reader page_cursor: String?
+
+        def page_cursor=: (String) -> String
+
+        attr_reader page_size: Integer?
+
+        def page_size=: (Integer) -> Integer
+
+        attr_reader status: Telnyx::Models::EmailMessages::RecipientListParams::status?
+
+        def status=: (
+          Telnyx::Models::EmailMessages::RecipientListParams::status
+        ) -> Telnyx::Models::EmailMessages::RecipientListParams::status
+
+        def initialize: (
+          email_id: String,
+          ?kind: Telnyx::Models::EmailMessages::RecipientListParams::kind,
+          ?page_cursor: String,
+          ?page_size: Integer,
+          ?status: Telnyx::Models::EmailMessages::RecipientListParams::status,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          email_id: String,
+          kind: Telnyx::Models::EmailMessages::RecipientListParams::kind,
+          page_cursor: String,
+          page_size: Integer,
+          status: Telnyx::Models::EmailMessages::RecipientListParams::status,
+          request_options: Telnyx::RequestOptions
+        }
+
+        type kind = :to | :cc | :bcc
+
+        module Kind
+          extend Telnyx::Internal::Type::Enum
+
+          TO: :to
+          CC: :cc
+          BCC: :bcc
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailMessages::RecipientListParams::kind]
+        end
+
+        type status =
+          :queued
+          | :sending
+          | :sent
+          | :deferred
+          | :delivered
+          | :bounced
+          | :failed
+          | :gw_reject
+          | :cancelled
+
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          QUEUED: :queued
+          SENDING: :sending
+          SENT: :sent
+          DEFERRED: :deferred
+          DELIVERED: :delivered
+          BOUNCED: :bounced
+          FAILED: :failed
+          GW_REJECT: :gw_reject
+          CANCELLED: :cancelled
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailMessages::RecipientListParams::status]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_messages/recipient_list_response.rbs

@@ -0,0 +1,39 @@
+module Telnyx
+  module Models
+    module EmailMessages
+      type recipient_list_response =
+        {
+          data: ::Array[Telnyx::EmailMessages::EmailRecipient],
+          meta: Telnyx::Models::EmailMessages::RecipientListResponse::Meta
+        }
+
+      class RecipientListResponse < Telnyx::Internal::Type::BaseModel
+        attr_accessor data: ::Array[Telnyx::EmailMessages::EmailRecipient]
+
+        attr_accessor meta: Telnyx::Models::EmailMessages::RecipientListResponse::Meta
+
+        def initialize: (
+          data: ::Array[Telnyx::EmailMessages::EmailRecipient],
+          meta: Telnyx::Models::EmailMessages::RecipientListResponse::Meta
+        ) -> void
+
+        def to_hash: -> {
+          data: ::Array[Telnyx::EmailMessages::EmailRecipient],
+          meta: Telnyx::Models::EmailMessages::RecipientListResponse::Meta
+        }
+
+        type meta = { page_size: Integer, page_cursor: String? }
+
+        class Meta < Telnyx::Internal::Type::BaseModel
+          attr_accessor page_size: Integer
+
+          attr_accessor page_cursor: String?
+
+          def initialize: (page_size: Integer, ?page_cursor: String?) -> void
+
+          def to_hash: -> { page_size: Integer, page_cursor: String? }
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_messages/recipient_retrieve_params.rbs

@@ -0,0 +1,30 @@
+module Telnyx
+  module Models
+    module EmailMessages
+      type recipient_retrieve_params =
+        { email_id: String, recipient_id: String }
+        & Telnyx::Internal::Type::request_parameters
+
+      class RecipientRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor email_id: String
+
+        attr_accessor recipient_id: String
+
+        def initialize: (
+          email_id: String,
+          recipient_id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          email_id: String,
+          recipient_id: String,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_messages/recipient_retrieve_response.rbs

@@ -0,0 +1,16 @@
+module Telnyx
+  module Models
+    module EmailMessages
+      type recipient_retrieve_response =
+        { data: Telnyx::EmailMessages::EmailRecipient }
+
+      class RecipientRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        attr_accessor data: Telnyx::EmailMessages::EmailRecipient
+
+        def initialize: (data: Telnyx::EmailMessages::EmailRecipient) -> void
+
+        def to_hash: -> { data: Telnyx::EmailMessages::EmailRecipient }
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_template.rbs

@@ -0,0 +1,70 @@
+module Telnyx
+  module Models
+    type email_template =
+      {
+        id: String,
+        created_at: Time,
+        html_body: String?,
+        name: String,
+        record_type: Telnyx::Models::EmailTemplate::record_type,
+        subject: String?,
+        text_body: String?,
+        updated_at: Time,
+        variables: ::Array[String]
+      }
+
+    class EmailTemplate < Telnyx::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor html_body: String?
+
+      attr_accessor name: String
+
+      attr_accessor record_type: Telnyx::Models::EmailTemplate::record_type
+
+      attr_accessor subject: String?
+
+      attr_accessor text_body: String?
+
+      attr_accessor updated_at: Time
+
+      attr_accessor variables: ::Array[String]
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        html_body: String?,
+        name: String,
+        record_type: Telnyx::Models::EmailTemplate::record_type,
+        subject: String?,
+        text_body: String?,
+        updated_at: Time,
+        variables: ::Array[String]
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        html_body: String?,
+        name: String,
+        record_type: Telnyx::Models::EmailTemplate::record_type,
+        subject: String?,
+        text_body: String?,
+        updated_at: Time,
+        variables: ::Array[String]
+      }
+
+      type record_type = :email_template
+
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        EMAIL_TEMPLATE: :email_template
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailTemplate::record_type]
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_template_create_params.rbs

@@ -0,0 +1,55 @@
+module Telnyx
+  module Models
+    type email_template_create_params =
+      {
+        name: String,
+        html_body: String?,
+        subject: String?,
+        text_body: String?,
+        variables: ::Array[String],
+        idempotency_key: String
+      }
+      & Telnyx::Internal::Type::request_parameters
+
+    class EmailTemplateCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor name: String
+
+      attr_accessor html_body: String?
+
+      attr_accessor subject: String?
+
+      attr_accessor text_body: String?
+
+      attr_reader variables: ::Array[String]?
+
+      def variables=: (::Array[String]) -> ::Array[String]
+
+      attr_reader idempotency_key: String?
+
+      def idempotency_key=: (String) -> String
+
+      def initialize: (
+        name: String,
+        ?html_body: String?,
+        ?subject: String?,
+        ?text_body: String?,
+        ?variables: ::Array[String],
+        ?idempotency_key: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        name: String,
+        html_body: String?,
+        subject: String?,
+        text_body: String?,
+        variables: ::Array[String],
+        idempotency_key: String,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_template_delete_params.rbs

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

data/sig/telnyx/models/email_template_list_params.rbs

@@ -0,0 +1,32 @@
+module Telnyx
+  module Models
+    type email_template_list_params =
+      { page_cursor: String, page_size: Integer }
+      & Telnyx::Internal::Type::request_parameters
+
+    class EmailTemplateListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_reader page_cursor: String?
+
+      def page_cursor=: (String) -> String
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      def initialize: (
+        ?page_cursor: String,
+        ?page_size: Integer,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        page_cursor: String,
+        page_size: Integer,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_template_list_response.rbs

@@ -0,0 +1,25 @@
+module Telnyx
+  module Models
+    type email_template_list_response =
+      {
+        data: ::Array[Telnyx::EmailTemplate],
+        meta: Telnyx::EmailInboxes::EmailPaginationMeta
+      }
+
+    class EmailTemplateListResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: ::Array[Telnyx::EmailTemplate]
+
+      attr_accessor meta: Telnyx::EmailInboxes::EmailPaginationMeta
+
+      def initialize: (
+        data: ::Array[Telnyx::EmailTemplate],
+        meta: Telnyx::EmailInboxes::EmailPaginationMeta
+      ) -> void
+
+      def to_hash: -> {
+        data: ::Array[Telnyx::EmailTemplate],
+        meta: Telnyx::EmailInboxes::EmailPaginationMeta
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_template_render_params.rbs

@@ -0,0 +1,30 @@
+module Telnyx
+  module Models
+    type email_template_render_params =
+      { id: String, template_variables: ::Hash[Symbol, top] }
+      & Telnyx::Internal::Type::request_parameters
+
+    class EmailTemplateRenderParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_reader template_variables: ::Hash[Symbol, top]?
+
+      def template_variables=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      def initialize: (
+        id: String,
+        ?template_variables: ::Hash[Symbol, top],
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        template_variables: ::Hash[Symbol, top],
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_template_render_response.rbs

@@ -0,0 +1,26 @@
+module Telnyx
+  module Models
+    type email_template_render_response =
+      { data: Telnyx::Models::EmailTemplateRenderResponse::Data }
+
+    class EmailTemplateRenderResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: Telnyx::Models::EmailTemplateRenderResponse::Data
+
+      def initialize: (
+        data: Telnyx::Models::EmailTemplateRenderResponse::Data
+      ) -> void
+
+      def to_hash: -> {
+        data: Telnyx::Models::EmailTemplateRenderResponse::Data
+      }
+
+      type data = {  }
+
+      class Data < Telnyx::Models::EmailTemplate
+        def initialize: -> void
+
+        def to_hash: -> {  }
+      end
+    end
+  end
+end