telnyx 5.158.0 → 5.159.0

data/sig/telnyx/models/email_inboxes/threads/label_delete_all_response.rbs

@@ -0,0 +1,68 @@
+module Telnyx
+  module Models
+    module EmailInboxes
+      module Threads
+        type label_delete_all_response =
+          {
+            data: Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data
+          }
+
+        class LabelDeleteAllResponse < Telnyx::Internal::Type::BaseModel
+          attr_accessor data: Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data
+
+          def initialize: (
+            data: Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data
+          ) -> void
+
+          def to_hash: -> {
+            data: Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data
+          }
+
+          type data =
+            {
+              id: String,
+              labels: ::Array[String],
+              record_type: Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data::record_type,
+              inbox_id: String
+            }
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            attr_accessor id: String
+
+            attr_accessor labels: ::Array[String]
+
+            attr_accessor record_type: Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data::record_type
+
+            attr_reader inbox_id: String?
+
+            def inbox_id=: (String) -> String
+
+            def initialize: (
+              id: String,
+              labels: ::Array[String],
+              record_type: Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data::record_type,
+              ?inbox_id: String
+            ) -> void
+
+            def to_hash: -> {
+              id: String,
+              labels: ::Array[String],
+              record_type: Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data::record_type,
+              inbox_id: String
+            }
+
+            type record_type = :email_thread
+
+            module RecordType
+              extend Telnyx::Internal::Type::Enum
+
+              EMAIL_THREAD: :email_thread
+
+              def self?.values: -> ::Array[Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse::Data::record_type]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_message_batch_params.rbs

@@ -0,0 +1,208 @@
+module Telnyx
+  module Models
+    type email_message_batch_params =
+      {
+        messages: ::Array[Telnyx::EmailMessageBatchParams::Message],
+        sandbox_mode: bool,
+        idempotency_key: String
+      }
+      & Telnyx::Internal::Type::request_parameters
+
+    class EmailMessageBatchParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor messages: ::Array[Telnyx::EmailMessageBatchParams::Message]
+
+      attr_reader sandbox_mode: bool?
+
+      def sandbox_mode=: (bool) -> bool
+
+      attr_reader idempotency_key: String?
+
+      def idempotency_key=: (String) -> String
+
+      def initialize: (
+        messages: ::Array[Telnyx::EmailMessageBatchParams::Message],
+        ?sandbox_mode: bool,
+        ?idempotency_key: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        messages: ::Array[Telnyx::EmailMessageBatchParams::Message],
+        sandbox_mode: bool,
+        idempotency_key: String,
+        request_options: Telnyx::RequestOptions
+      }
+
+      type message =
+        {
+          from: Telnyx::Models::email_address_input,
+          to: ::Array[Telnyx::Models::email_address_input],
+          attachments: ::Array[Telnyx::AttachmentRequest],
+          bcc: ::Array[Telnyx::Models::email_address_input],
+          cc: ::Array[Telnyx::Models::email_address_input],
+          from_name: String,
+          group_id: String?,
+          headers: ::Hash[Symbol, String],
+          html_body: String,
+          ignore_suppression: bool,
+          inline_css: bool,
+          metadata: ::Hash[Symbol, top],
+          reply_to: Telnyx::Models::email_address_input,
+          sandbox_mode: bool,
+          scheduled_at: Time?,
+          send_at: Time,
+          subject: String,
+          tags: ::Array[String],
+          template_id: String,
+          template_variables: ::Hash[Symbol, top],
+          text_body: String,
+          tracking_settings: Telnyx::TrackingSettings
+        }
+
+      class Message < Telnyx::Internal::Type::BaseModel
+        attr_accessor from: Telnyx::Models::email_address_input
+
+        attr_accessor to: ::Array[Telnyx::Models::email_address_input]
+
+        attr_reader attachments: ::Array[Telnyx::AttachmentRequest]?
+
+        def attachments=: (
+          ::Array[Telnyx::AttachmentRequest]
+        ) -> ::Array[Telnyx::AttachmentRequest]
+
+        attr_reader bcc: ::Array[Telnyx::Models::email_address_input]?
+
+        def bcc=: (
+          ::Array[Telnyx::Models::email_address_input]
+        ) -> ::Array[Telnyx::Models::email_address_input]
+
+        attr_reader cc: ::Array[Telnyx::Models::email_address_input]?
+
+        def cc=: (
+          ::Array[Telnyx::Models::email_address_input]
+        ) -> ::Array[Telnyx::Models::email_address_input]
+
+        attr_reader from_name: String?
+
+        def from_name=: (String) -> String
+
+        attr_accessor group_id: String?
+
+        attr_reader headers: ::Hash[Symbol, String]?
+
+        def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+        attr_reader html_body: String?
+
+        def html_body=: (String) -> String
+
+        attr_reader ignore_suppression: bool?
+
+        def ignore_suppression=: (bool) -> bool
+
+        attr_reader inline_css: bool?
+
+        def inline_css=: (bool) -> bool
+
+        attr_reader metadata: ::Hash[Symbol, top]?
+
+        def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader reply_to: Telnyx::Models::email_address_input?
+
+        def reply_to=: (
+          Telnyx::Models::email_address_input
+        ) -> Telnyx::Models::email_address_input
+
+        attr_reader sandbox_mode: bool?
+
+        def sandbox_mode=: (bool) -> bool
+
+        attr_accessor scheduled_at: Time?
+
+        attr_reader send_at: Time?
+
+        def send_at=: (Time) -> Time
+
+        attr_reader subject: String?
+
+        def subject=: (String) -> String
+
+        attr_reader tags: ::Array[String]?
+
+        def tags=: (::Array[String]) -> ::Array[String]
+
+        attr_reader template_id: String?
+
+        def template_id=: (String) -> String
+
+        attr_reader template_variables: ::Hash[Symbol, top]?
+
+        def template_variables=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader text_body: String?
+
+        def text_body=: (String) -> String
+
+        attr_reader tracking_settings: Telnyx::TrackingSettings?
+
+        def tracking_settings=: (
+          Telnyx::TrackingSettings
+        ) -> Telnyx::TrackingSettings
+
+        def initialize: (
+          from: Telnyx::Models::email_address_input,
+          to: ::Array[Telnyx::Models::email_address_input],
+          ?attachments: ::Array[Telnyx::AttachmentRequest],
+          ?bcc: ::Array[Telnyx::Models::email_address_input],
+          ?cc: ::Array[Telnyx::Models::email_address_input],
+          ?from_name: String,
+          ?group_id: String?,
+          ?headers: ::Hash[Symbol, String],
+          ?html_body: String,
+          ?ignore_suppression: bool,
+          ?inline_css: bool,
+          ?metadata: ::Hash[Symbol, top],
+          ?reply_to: Telnyx::Models::email_address_input,
+          ?sandbox_mode: bool,
+          ?scheduled_at: Time?,
+          ?send_at: Time,
+          ?subject: String,
+          ?tags: ::Array[String],
+          ?template_id: String,
+          ?template_variables: ::Hash[Symbol, top],
+          ?text_body: String,
+          ?tracking_settings: Telnyx::TrackingSettings
+        ) -> void
+
+        def to_hash: -> {
+          from: Telnyx::Models::email_address_input,
+          to: ::Array[Telnyx::Models::email_address_input],
+          attachments: ::Array[Telnyx::AttachmentRequest],
+          bcc: ::Array[Telnyx::Models::email_address_input],
+          cc: ::Array[Telnyx::Models::email_address_input],
+          from_name: String,
+          group_id: String?,
+          headers: ::Hash[Symbol, String],
+          html_body: String,
+          ignore_suppression: bool,
+          inline_css: bool,
+          metadata: ::Hash[Symbol, top],
+          reply_to: Telnyx::Models::email_address_input,
+          sandbox_mode: bool,
+          scheduled_at: Time?,
+          send_at: Time,
+          subject: String,
+          tags: ::Array[String],
+          template_id: String,
+          template_variables: ::Hash[Symbol, top],
+          text_body: String,
+          tracking_settings: Telnyx::TrackingSettings
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_message_batch_response.rbs

@@ -0,0 +1,98 @@
+module Telnyx
+  module Models
+    type email_message_batch_response =
+      {
+        data: ::Array[Telnyx::EmailInboxes::EmailMessage],
+        errors: ::Array[Telnyx::Models::EmailMessageBatchResponse::Error],
+        meta: Telnyx::Models::EmailMessageBatchResponse::Meta
+      }
+
+    class EmailMessageBatchResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: ::Array[Telnyx::EmailInboxes::EmailMessage]
+
+      attr_accessor errors: ::Array[Telnyx::Models::EmailMessageBatchResponse::Error]
+
+      attr_accessor meta: Telnyx::Models::EmailMessageBatchResponse::Meta
+
+      def initialize: (
+        data: ::Array[Telnyx::EmailInboxes::EmailMessage],
+        errors: ::Array[Telnyx::Models::EmailMessageBatchResponse::Error],
+        meta: Telnyx::Models::EmailMessageBatchResponse::Meta
+      ) -> void
+
+      def to_hash: -> {
+        data: ::Array[Telnyx::EmailInboxes::EmailMessage],
+        errors: ::Array[Telnyx::Models::EmailMessageBatchResponse::Error],
+        meta: Telnyx::Models::EmailMessageBatchResponse::Meta
+      }
+
+      type error =
+        {
+          code: Telnyx::Models::EmailMessageBatchResponse::Error::code,
+          index: Integer,
+          message: String
+        }
+
+      class Error < Telnyx::Internal::Type::BaseModel
+        attr_accessor code: Telnyx::Models::EmailMessageBatchResponse::Error::code
+
+        attr_accessor index: Integer
+
+        attr_accessor message: String
+
+        def initialize: (
+          code: Telnyx::Models::EmailMessageBatchResponse::Error::code,
+          index: Integer,
+          message: String
+        ) -> void
+
+        def to_hash: -> {
+          code: Telnyx::Models::EmailMessageBatchResponse::Error::code,
+          index: Integer,
+          message: String
+        }
+
+        type code =
+          :bad_request
+          | :not_found
+          | :forbidden
+          | :service_unavailable
+          | :validation_error
+          | :recipient_suppressed
+          | :reputation_suspended
+
+        module Code
+          extend Telnyx::Internal::Type::Enum
+
+          BAD_REQUEST: :bad_request
+          NOT_FOUND: :not_found
+          FORBIDDEN: :forbidden
+          SERVICE_UNAVAILABLE: :service_unavailable
+          VALIDATION_ERROR: :validation_error
+          RECIPIENT_SUPPRESSED: :recipient_suppressed
+          REPUTATION_SUSPENDED: :reputation_suspended
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailMessageBatchResponse::Error::code]
+        end
+      end
+
+      type meta = { failed: Integer, succeeded: Integer, total: Integer }
+
+      class Meta < Telnyx::Internal::Type::BaseModel
+        attr_accessor failed: Integer
+
+        attr_accessor succeeded: Integer
+
+        attr_accessor total: Integer
+
+        def initialize: (
+          failed: Integer,
+          succeeded: Integer,
+          total: Integer
+        ) -> void
+
+        def to_hash: -> { failed: Integer, succeeded: Integer, total: Integer }
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_message_create_params.rbs

@@ -0,0 +1,199 @@
+module Telnyx
+  module Models
+    type email_message_create_params =
+      {
+        from: Telnyx::Models::email_address_input,
+        to: ::Array[Telnyx::Models::email_address_input],
+        attachments: ::Array[Telnyx::AttachmentRequest],
+        bcc: ::Array[Telnyx::Models::email_address_input],
+        cc: ::Array[Telnyx::Models::email_address_input],
+        forward_of_message_id: String?,
+        from_name: String,
+        group_id: String?,
+        headers: ::Hash[Symbol, String],
+        html_body: String,
+        ignore_suppression: bool,
+        in_reply_to_message_id: String?,
+        inline_css: bool,
+        metadata: ::Hash[Symbol, top],
+        reply_to: Telnyx::Models::email_address_input,
+        reply_to_all: bool?,
+        sandbox_mode: bool,
+        scheduled_at: Time?,
+        send_at: Time,
+        subject: String,
+        tags: ::Array[String],
+        template_id: String,
+        template_variables: ::Hash[Symbol, top],
+        text_body: String,
+        tracking_settings: Telnyx::TrackingSettings,
+        idempotency_key: String
+      }
+      & Telnyx::Internal::Type::request_parameters
+
+    class EmailMessageCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor from: Telnyx::Models::email_address_input
+
+      attr_accessor to: ::Array[Telnyx::Models::email_address_input]
+
+      attr_reader attachments: ::Array[Telnyx::AttachmentRequest]?
+
+      def attachments=: (
+        ::Array[Telnyx::AttachmentRequest]
+      ) -> ::Array[Telnyx::AttachmentRequest]
+
+      attr_reader bcc: ::Array[Telnyx::Models::email_address_input]?
+
+      def bcc=: (
+        ::Array[Telnyx::Models::email_address_input]
+      ) -> ::Array[Telnyx::Models::email_address_input]
+
+      attr_reader cc: ::Array[Telnyx::Models::email_address_input]?
+
+      def cc=: (
+        ::Array[Telnyx::Models::email_address_input]
+      ) -> ::Array[Telnyx::Models::email_address_input]
+
+      attr_accessor forward_of_message_id: String?
+
+      attr_reader from_name: String?
+
+      def from_name=: (String) -> String
+
+      attr_accessor group_id: String?
+
+      attr_reader headers: ::Hash[Symbol, String]?
+
+      def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+      attr_reader html_body: String?
+
+      def html_body=: (String) -> String
+
+      attr_reader ignore_suppression: bool?
+
+      def ignore_suppression=: (bool) -> bool
+
+      attr_accessor in_reply_to_message_id: String?
+
+      attr_reader inline_css: bool?
+
+      def inline_css=: (bool) -> bool
+
+      attr_reader metadata: ::Hash[Symbol, top]?
+
+      def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader reply_to: Telnyx::Models::email_address_input?
+
+      def reply_to=: (
+        Telnyx::Models::email_address_input
+      ) -> Telnyx::Models::email_address_input
+
+      attr_accessor reply_to_all: bool?
+
+      attr_reader sandbox_mode: bool?
+
+      def sandbox_mode=: (bool) -> bool
+
+      attr_accessor scheduled_at: Time?
+
+      attr_reader send_at: Time?
+
+      def send_at=: (Time) -> Time
+
+      attr_reader subject: String?
+
+      def subject=: (String) -> String
+
+      attr_reader tags: ::Array[String]?
+
+      def tags=: (::Array[String]) -> ::Array[String]
+
+      attr_reader template_id: String?
+
+      def template_id=: (String) -> String
+
+      attr_reader template_variables: ::Hash[Symbol, top]?
+
+      def template_variables=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader text_body: String?
+
+      def text_body=: (String) -> String
+
+      attr_reader tracking_settings: Telnyx::TrackingSettings?
+
+      def tracking_settings=: (
+        Telnyx::TrackingSettings
+      ) -> Telnyx::TrackingSettings
+
+      attr_reader idempotency_key: String?
+
+      def idempotency_key=: (String) -> String
+
+      def initialize: (
+        from: Telnyx::Models::email_address_input,
+        to: ::Array[Telnyx::Models::email_address_input],
+        ?attachments: ::Array[Telnyx::AttachmentRequest],
+        ?bcc: ::Array[Telnyx::Models::email_address_input],
+        ?cc: ::Array[Telnyx::Models::email_address_input],
+        ?forward_of_message_id: String?,
+        ?from_name: String,
+        ?group_id: String?,
+        ?headers: ::Hash[Symbol, String],
+        ?html_body: String,
+        ?ignore_suppression: bool,
+        ?in_reply_to_message_id: String?,
+        ?inline_css: bool,
+        ?metadata: ::Hash[Symbol, top],
+        ?reply_to: Telnyx::Models::email_address_input,
+        ?reply_to_all: bool?,
+        ?sandbox_mode: bool,
+        ?scheduled_at: Time?,
+        ?send_at: Time,
+        ?subject: String,
+        ?tags: ::Array[String],
+        ?template_id: String,
+        ?template_variables: ::Hash[Symbol, top],
+        ?text_body: String,
+        ?tracking_settings: Telnyx::TrackingSettings,
+        ?idempotency_key: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        from: Telnyx::Models::email_address_input,
+        to: ::Array[Telnyx::Models::email_address_input],
+        attachments: ::Array[Telnyx::AttachmentRequest],
+        bcc: ::Array[Telnyx::Models::email_address_input],
+        cc: ::Array[Telnyx::Models::email_address_input],
+        forward_of_message_id: String?,
+        from_name: String,
+        group_id: String?,
+        headers: ::Hash[Symbol, String],
+        html_body: String,
+        ignore_suppression: bool,
+        in_reply_to_message_id: String?,
+        inline_css: bool,
+        metadata: ::Hash[Symbol, top],
+        reply_to: Telnyx::Models::email_address_input,
+        reply_to_all: bool?,
+        sandbox_mode: bool,
+        scheduled_at: Time?,
+        send_at: Time,
+        subject: String,
+        tags: ::Array[String],
+        template_id: String,
+        template_variables: ::Hash[Symbol, top],
+        text_body: String,
+        tracking_settings: Telnyx::TrackingSettings,
+        idempotency_key: String,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_message_delete_all_params.rbs

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

data/sig/telnyx/models/email_message_delete_params.rbs

@@ -0,0 +1,20 @@
+module Telnyx
+  module Models
+    type email_message_delete_params =
+      { id: String } & Telnyx::Internal::Type::request_parameters
+
+    class EmailMessageDeleteParams < 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_delete_schedule_params.rbs

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

data/sig/telnyx/models/email_message_list_params.rbs

@@ -0,0 +1,32 @@
+module Telnyx
+  module Models
+    type email_message_list_params =
+      { 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 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_message_list_response.rbs

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