telnyx 5.168.0 → 5.170.0

data/sig/telnyx/models/email_event_list_response.rbs

@@ -2,95 +2,271 @@ module Telnyx
   module Models
     type email_event_list_response =
       {
-        id: String,
-        email_id: String,
-        occurred_at: Time,
-        record_type: Telnyx::Models::EmailEventListResponse::record_type,
-        type: Telnyx::Models::email_event_type,
-        email: Telnyx::Models::EmailEventListResponse::Email,
-        payload: ::Hash[Symbol, top]
+        data: ::Array[Telnyx::Models::EmailEventListResponse::Data],
+        meta: Telnyx::Models::EmailEventListResponse::Meta
       }
 
     class EmailEventListResponse < Telnyx::Internal::Type::BaseModel
-      attr_accessor id: String
+      attr_accessor data: ::Array[Telnyx::Models::EmailEventListResponse::Data]
 
-      attr_accessor email_id: String
+      attr_accessor meta: Telnyx::Models::EmailEventListResponse::Meta
 
-      attr_accessor occurred_at: Time
+      def initialize: (
+        data: ::Array[Telnyx::Models::EmailEventListResponse::Data],
+        meta: Telnyx::Models::EmailEventListResponse::Meta
+      ) -> void
 
-      attr_accessor record_type: Telnyx::Models::EmailEventListResponse::record_type
+      def to_hash: -> {
+        data: ::Array[Telnyx::Models::EmailEventListResponse::Data],
+        meta: Telnyx::Models::EmailEventListResponse::Meta
+      }
 
-      attr_accessor type: Telnyx::Models::email_event_type
+      type data =
+        {
+          id: String,
+          canonical_event_type: String,
+          event_type: String,
+          occurred_at: Time,
+          payload: Telnyx::Models::EmailEventListResponse::Data::Payload,
+          recipient_id: String
+        }
 
-      attr_reader email: Telnyx::Models::EmailEventListResponse::Email?
+      class Data < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
 
-      def email=: (
-        Telnyx::Models::EmailEventListResponse::Email
-      ) -> Telnyx::Models::EmailEventListResponse::Email
+        attr_accessor canonical_event_type: String
 
-      attr_reader payload: ::Hash[Symbol, top]?
+        attr_accessor event_type: String
 
-      def payload=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+        attr_accessor occurred_at: Time
 
-      def initialize: (
-        id: String,
-        email_id: String,
-        occurred_at: Time,
-        record_type: Telnyx::Models::EmailEventListResponse::record_type,
-        type: Telnyx::Models::email_event_type,
-        ?email: Telnyx::Models::EmailEventListResponse::Email,
-        ?payload: ::Hash[Symbol, top]
-      ) -> void
+        attr_accessor payload: Telnyx::Models::EmailEventListResponse::Data::Payload
 
-      def to_hash: -> {
-        id: String,
-        email_id: String,
-        occurred_at: Time,
-        record_type: Telnyx::Models::EmailEventListResponse::record_type,
-        type: Telnyx::Models::email_event_type,
-        email: Telnyx::Models::EmailEventListResponse::Email,
-        payload: ::Hash[Symbol, top]
-      }
+        attr_reader recipient_id: String?
+
+        def recipient_id=: (String) -> String
+
+        def initialize: (
+          id: String,
+          canonical_event_type: String,
+          event_type: String,
+          occurred_at: Time,
+          payload: Telnyx::Models::EmailEventListResponse::Data::Payload,
+          ?recipient_id: String
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          canonical_event_type: String,
+          event_type: String,
+          occurred_at: Time,
+          payload: Telnyx::Models::EmailEventListResponse::Data::Payload,
+          recipient_id: String
+        }
+
+        type payload =
+          {
+            id: String,
+            occurred_at: Time,
+            status: Telnyx::Models::EmailEventListResponse::Data::Payload::status,
+            bcc: Telnyx::Models::EmailEventListResponse::Data::Payload::bcc,
+            cc: Telnyx::Models::EmailEventListResponse::Data::Payload::cc,
+            from: Telnyx::Models::EmailEventListResponse::Data::Payload::From,
+            recipient_id: String,
+            subject: String,
+            to: Telnyx::Models::EmailEventListResponse::Data::Payload::to
+          }
+
+        class Payload < Telnyx::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor occurred_at: Time
+
+          attr_accessor status: Telnyx::Models::EmailEventListResponse::Data::Payload::status
+
+          attr_reader bcc: Telnyx::Models::EmailEventListResponse::Data::Payload::bcc?
+
+          def bcc=: (
+            Telnyx::Models::EmailEventListResponse::Data::Payload::bcc
+          ) -> Telnyx::Models::EmailEventListResponse::Data::Payload::bcc
+
+          attr_reader cc: Telnyx::Models::EmailEventListResponse::Data::Payload::cc?
+
+          def cc=: (
+            Telnyx::Models::EmailEventListResponse::Data::Payload::cc
+          ) -> Telnyx::Models::EmailEventListResponse::Data::Payload::cc
+
+          attr_reader from: Telnyx::Models::EmailEventListResponse::Data::Payload::From?
+
+          def from=: (
+            Telnyx::Models::EmailEventListResponse::Data::Payload::From
+          ) -> Telnyx::Models::EmailEventListResponse::Data::Payload::From
+
+          attr_reader recipient_id: String?
+
+          def recipient_id=: (String) -> String
+
+          attr_reader subject: String?
+
+          def subject=: (String) -> String
+
+          attr_reader to: Telnyx::Models::EmailEventListResponse::Data::Payload::to?
+
+          def to=: (
+            Telnyx::Models::EmailEventListResponse::Data::Payload::to
+          ) -> Telnyx::Models::EmailEventListResponse::Data::Payload::to
+
+          def initialize: (
+            id: String,
+            occurred_at: Time,
+            status: Telnyx::Models::EmailEventListResponse::Data::Payload::status,
+            ?bcc: Telnyx::Models::EmailEventListResponse::Data::Payload::bcc,
+            ?cc: Telnyx::Models::EmailEventListResponse::Data::Payload::cc,
+            ?from: Telnyx::Models::EmailEventListResponse::Data::Payload::From,
+            ?recipient_id: String,
+            ?subject: String,
+            ?to: Telnyx::Models::EmailEventListResponse::Data::Payload::to
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            occurred_at: Time,
+            status: Telnyx::Models::EmailEventListResponse::Data::Payload::status,
+            bcc: Telnyx::Models::EmailEventListResponse::Data::Payload::bcc,
+            cc: Telnyx::Models::EmailEventListResponse::Data::Payload::cc,
+            from: Telnyx::Models::EmailEventListResponse::Data::Payload::From,
+            recipient_id: String,
+            subject: String,
+            to: Telnyx::Models::EmailEventListResponse::Data::Payload::to
+          }
+
+          type status =
+            :queued
+            | :deferred
+            | :scheduled
+            | :cancelled
+            | :sandbox
+            | :sending
+            | :sent
+            | :failed
+            | :delivered
+            | :bounced
+            | :complained
+            | :suppressed
+            | :rejected
+            | :opened
+            | :clicked
+            | :unsubscribed
+            | :daily_limit_exceeded
+            | :scan_deferred
+            | :quarantined
+            | :quarantine_released
+            | :quarantine_release_dispatched
+            | :quarantine_rejected
+            | :quarantine_expired
+            | :gw_reject
+            | :injection_timeout
+            | :expired
+
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            QUEUED: :queued
+            DEFERRED: :deferred
+            SCHEDULED: :scheduled
+            CANCELLED: :cancelled
+            SANDBOX: :sandbox
+            SENDING: :sending
+            SENT: :sent
+            FAILED: :failed
+            DELIVERED: :delivered
+            BOUNCED: :bounced
+            COMPLAINED: :complained
+            SUPPRESSED: :suppressed
+            REJECTED: :rejected
+            OPENED: :opened
+            CLICKED: :clicked
+            UNSUBSCRIBED: :unsubscribed
+            DAILY_LIMIT_EXCEEDED: :daily_limit_exceeded
+            SCAN_DEFERRED: :scan_deferred
+            QUARANTINED: :quarantined
+            QUARANTINE_RELEASED: :quarantine_released
+            QUARANTINE_RELEASE_DISPATCHED: :quarantine_release_dispatched
+            QUARANTINE_REJECTED: :quarantine_rejected
+            QUARANTINE_EXPIRED: :quarantine_expired
+            GW_REJECT: :gw_reject
+            INJECTION_TIMEOUT: :injection_timeout
+            EXPIRED: :expired
+
+            def self?.values: -> ::Array[Telnyx::Models::EmailEventListResponse::Data::Payload::status]
+          end
+
+          type bcc = Telnyx::EmailWebhookRecipient | :redacted
+
+          module Bcc
+            extend Telnyx::Internal::Type::Union
+
+            def self?.variants: -> ::Array[Telnyx::Models::EmailEventListResponse::Data::Payload::bcc]
+
+            REDACTED: :redacted
+          end
+
+          type cc = Telnyx::EmailWebhookRecipient | String
+
+          module Cc
+            extend Telnyx::Internal::Type::Union
+
+            def self?.variants: -> ::Array[Telnyx::Models::EmailEventListResponse::Data::Payload::cc]
+          end
+
+          type from = { email: String, name: String? }
+
+          class From < Telnyx::Internal::Type::BaseModel
+            attr_accessor email: String
+
+            attr_accessor name: String?
+
+            def initialize: (email: String, name: String?) -> void
 
-      type record_type = :email_event
+            def to_hash: -> { email: String, name: String? }
+          end
 
-      module RecordType
-        extend Telnyx::Internal::Type::Enum
+          type to = Telnyx::EmailWebhookRecipient | String
 
-        EMAIL_EVENT: :email_event
+          module To
+            extend Telnyx::Internal::Type::Union
 
-        def self?.values: -> ::Array[Telnyx::Models::EmailEventListResponse::record_type]
+            def self?.variants: -> ::Array[Telnyx::Models::EmailEventListResponse::Data::Payload::to]
+          end
+        end
       end
 
-      type email =
+      type meta =
         {
-          cc: ::Array[Telnyx::EmailInboxes::EmailAddress],
-          from: Telnyx::EmailInboxes::EmailAddress,
-          subject: String,
-          to: ::Array[Telnyx::EmailInboxes::EmailAddress]
+          page_size: Integer,
+          time_range: Telnyx::TimeRange,
+          page_cursor: String
         }
 
-      class Email < Telnyx::Internal::Type::BaseModel
-        attr_accessor cc: ::Array[Telnyx::EmailInboxes::EmailAddress]
+      class Meta < Telnyx::Internal::Type::BaseModel
+        attr_accessor page_size: Integer
 
-        attr_accessor from: Telnyx::EmailInboxes::EmailAddress
+        attr_accessor time_range: Telnyx::TimeRange
 
-        attr_accessor subject: String
+        attr_reader page_cursor: String?
 
-        attr_accessor to: ::Array[Telnyx::EmailInboxes::EmailAddress]
+        def page_cursor=: (String) -> String
 
         def initialize: (
-          cc: ::Array[Telnyx::EmailInboxes::EmailAddress],
-          from: Telnyx::EmailInboxes::EmailAddress,
-          subject: String,
-          to: ::Array[Telnyx::EmailInboxes::EmailAddress]
+          page_size: Integer,
+          time_range: Telnyx::TimeRange,
+          ?page_cursor: String
         ) -> void
 
         def to_hash: -> {
-          cc: ::Array[Telnyx::EmailInboxes::EmailAddress],
-          from: Telnyx::EmailInboxes::EmailAddress,
-          subject: String,
-          to: ::Array[Telnyx::EmailInboxes::EmailAddress]
+          page_size: Integer,
+          time_range: Telnyx::TimeRange,
+          page_cursor: String
         }
       end
     end

data/sig/telnyx/models/email_event_type.rbs

@@ -12,11 +12,21 @@ module Telnyx
       | :delivered
       | :bounced
       | :complained
+      | :suppressed
       | :rejected
       | :opened
       | :clicked
       | :unsubscribed
       | :daily_limit_exceeded
+      | :scan_deferred
+      | :quarantined
+      | :quarantine_released
+      | :quarantine_release_dispatched
+      | :quarantine_rejected
+      | :quarantine_expired
+      | :gw_reject
+      | :injection_timeout
+      | :expired
 
     module EmailEventType
       extend Telnyx::Internal::Type::Enum
@@ -32,11 +42,21 @@ module Telnyx
       DELIVERED: :delivered
       BOUNCED: :bounced
       COMPLAINED: :complained
+      SUPPRESSED: :suppressed
       REJECTED: :rejected
       OPENED: :opened
       CLICKED: :clicked
       UNSUBSCRIBED: :unsubscribed
       DAILY_LIMIT_EXCEEDED: :daily_limit_exceeded
+      SCAN_DEFERRED: :scan_deferred
+      QUARANTINED: :quarantined
+      QUARANTINE_RELEASED: :quarantine_released
+      QUARANTINE_RELEASE_DISPATCHED: :quarantine_release_dispatched
+      QUARANTINE_REJECTED: :quarantine_rejected
+      QUARANTINE_EXPIRED: :quarantine_expired
+      GW_REJECT: :gw_reject
+      INJECTION_TIMEOUT: :injection_timeout
+      EXPIRED: :expired
 
       def self?.values: -> ::Array[Telnyx::Models::email_event_type]
     end

data/sig/telnyx/models/email_inboxes/email_message.rbs

@@ -8,12 +8,14 @@ module Telnyx
           bcc: ::Array[Telnyx::EmailInboxes::EmailAddress],
           cc: ::Array[Telnyx::EmailInboxes::EmailAddress],
           created_at: Time,
-          events: ::Array[Telnyx::MessageEvent],
+          events: ::Array[Telnyx::EmailInboxes::EmailMessage::Event],
           from: Telnyx::EmailInboxes::EmailAddress,
+          metadata: ::Hash[Symbol, top],
           record_type: Telnyx::Models::EmailInboxes::EmailMessage::record_type,
           reply_to: String?,
           status: Telnyx::Models::EmailInboxes::EmailMessage::status,
           subject: String,
+          tags: ::Array[String],
           template_id: String?,
           template_variables: ::Hash[Symbol, top],
           to: ::Array[Telnyx::EmailInboxes::EmailAddress],
@@ -35,10 +37,12 @@ module Telnyx
 
         attr_accessor created_at: Time
 
-        attr_accessor events: ::Array[Telnyx::MessageEvent]
+        attr_accessor events: ::Array[Telnyx::EmailInboxes::EmailMessage::Event]
 
         attr_accessor from: Telnyx::EmailInboxes::EmailAddress
 
+        attr_accessor metadata: ::Hash[Symbol, top]
+
         attr_accessor record_type: Telnyx::Models::EmailInboxes::EmailMessage::record_type
 
         attr_accessor reply_to: String?
@@ -47,6 +51,8 @@ module Telnyx
 
         attr_accessor subject: String
 
+        attr_accessor tags: ::Array[String]
+
         attr_accessor template_id: String?
 
         attr_accessor template_variables: ::Hash[Symbol, top]
@@ -83,12 +89,14 @@ module Telnyx
           bcc: ::Array[Telnyx::EmailInboxes::EmailAddress],
           cc: ::Array[Telnyx::EmailInboxes::EmailAddress],
           created_at: Time,
-          events: ::Array[Telnyx::MessageEvent],
+          events: ::Array[Telnyx::EmailInboxes::EmailMessage::Event],
           from: Telnyx::EmailInboxes::EmailAddress,
+          metadata: ::Hash[Symbol, top],
           record_type: Telnyx::Models::EmailInboxes::EmailMessage::record_type,
           reply_to: String?,
           status: Telnyx::Models::EmailInboxes::EmailMessage::status,
           subject: String,
+          tags: ::Array[String],
           template_id: String?,
           template_variables: ::Hash[Symbol, top],
           to: ::Array[Telnyx::EmailInboxes::EmailAddress],
@@ -105,12 +113,14 @@ module Telnyx
           bcc: ::Array[Telnyx::EmailInboxes::EmailAddress],
           cc: ::Array[Telnyx::EmailInboxes::EmailAddress],
           created_at: Time,
-          events: ::Array[Telnyx::MessageEvent],
+          events: ::Array[Telnyx::EmailInboxes::EmailMessage::Event],
           from: Telnyx::EmailInboxes::EmailAddress,
+          metadata: ::Hash[Symbol, top],
           record_type: Telnyx::Models::EmailInboxes::EmailMessage::record_type,
           reply_to: String?,
           status: Telnyx::Models::EmailInboxes::EmailMessage::status,
           subject: String,
+          tags: ::Array[String],
           template_id: String?,
           template_variables: ::Hash[Symbol, top],
           to: ::Array[Telnyx::EmailInboxes::EmailAddress],
@@ -168,6 +178,35 @@ module Telnyx
           }
         end
 
+        type event =
+          {
+            occurred_at: Time,
+            type: Telnyx::Models::email_event_type,
+            payload: ::Hash[Symbol, top]
+          }
+
+        class Event < Telnyx::Internal::Type::BaseModel
+          attr_accessor occurred_at: Time
+
+          attr_accessor type: Telnyx::Models::email_event_type
+
+          attr_reader payload: ::Hash[Symbol, top]?
+
+          def payload=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+          def initialize: (
+            occurred_at: Time,
+            type: Telnyx::Models::email_event_type,
+            ?payload: ::Hash[Symbol, top]
+          ) -> void
+
+          def to_hash: -> {
+            occurred_at: Time,
+            type: Telnyx::Models::email_event_type,
+            payload: ::Hash[Symbol, top]
+          }
+        end
+
         type record_type = :email_message
 
         module RecordType

data/sig/telnyx/models/{email_message_retrieve_response.rbs → email_message_detail_response.rbs}

@@ -1,18 +1,14 @@
 module Telnyx
   module Models
-    type email_message_retrieve_response =
-      { data: Telnyx::Models::EmailMessageRetrieveResponse::Data }
+    type email_message_detail_response =
+      { data: Telnyx::EmailMessageDetailResponse::Data }
 
-    class EmailMessageRetrieveResponse < Telnyx::Internal::Type::BaseModel
-      attr_accessor data: Telnyx::Models::EmailMessageRetrieveResponse::Data
+    class EmailMessageDetailResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: Telnyx::EmailMessageDetailResponse::Data
 
-      def initialize: (
-        data: Telnyx::Models::EmailMessageRetrieveResponse::Data
-      ) -> void
+      def initialize: (data: Telnyx::EmailMessageDetailResponse::Data) -> void
 
-      def to_hash: -> {
-        data: Telnyx::Models::EmailMessageRetrieveResponse::Data
-      }
+      def to_hash: -> { data: Telnyx::EmailMessageDetailResponse::Data }
 
       type data = { html_body: String?, text_body: String? }
 

data/sig/telnyx/models/email_message_list_params.rbs

@@ -1,13 +1,26 @@
 module Telnyx
   module Models
     type email_message_list_params =
-      { page_cursor: String, page_size: Integer }
+      {
+        filter_metadata: String,
+        filter_tags: String,
+        page_cursor: String,
+        page_size: Integer
+      }
       & Telnyx::Internal::Type::request_parameters
 
     class EmailMessageListParams < Telnyx::Internal::Type::BaseModel
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
+      attr_reader filter_metadata: String?
+
+      def filter_metadata=: (String) -> String
+
+      attr_reader filter_tags: String?
+
+      def filter_tags=: (String) -> String
+
       attr_reader page_cursor: String?
 
       def page_cursor=: (String) -> String
@@ -17,12 +30,16 @@ module Telnyx
       def page_size=: (Integer) -> Integer
 
       def initialize: (
+        ?filter_metadata: String,
+        ?filter_tags: String,
         ?page_cursor: String,
         ?page_size: Integer,
         ?request_options: Telnyx::request_opts
       ) -> void
 
       def to_hash: -> {
+        filter_metadata: String,
+        filter_tags: String,
         page_cursor: String,
         page_size: Integer,
         request_options: Telnyx::RequestOptions

data/sig/telnyx/models/email_message_update_schedule_params.rbs

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

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

@@ -104,6 +104,8 @@ module Telnyx
           | :failed
           | :gw_reject
           | :cancelled
+          | :injection_timeout
+          | :expired
 
         module Status
           extend Telnyx::Internal::Type::Enum
@@ -117,6 +119,8 @@ module Telnyx
           FAILED: :failed
           GW_REJECT: :gw_reject
           CANCELLED: :cancelled
+          INJECTION_TIMEOUT: :injection_timeout
+          EXPIRED: :expired
 
           def self?.values: -> ::Array[Telnyx::Models::EmailMessages::EmailRecipient::status]
         end

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

@@ -77,6 +77,8 @@ module Telnyx
           | :failed
           | :gw_reject
           | :cancelled
+          | :injection_timeout
+          | :expired
 
         module Status
           extend Telnyx::Internal::Type::Enum
@@ -90,6 +92,8 @@ module Telnyx
           FAILED: :failed
           GW_REJECT: :gw_reject
           CANCELLED: :cancelled
+          INJECTION_TIMEOUT: :injection_timeout
+          EXPIRED: :expired
 
           def self?.values: -> ::Array[Telnyx::Models::EmailMessages::RecipientListParams::status]
         end