telnyx 5.158.0 → 5.159.0

data/sig/telnyx/resources/email_domains.rbs

@@ -0,0 +1,66 @@
+module Telnyx
+  module Resources
+    class EmailDomains
+      attr_reader webhooks: Telnyx::Resources::EmailDomains::Webhooks
+
+      def create: (
+        domain: String,
+        ?dmarc_policy: Telnyx::EmailDmarcPolicy?,
+        ?inbound_enabled: bool,
+        ?tracking: Telnyx::DomainsTrackingSettings,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailDomainResponse
+
+      def retrieve: (
+        String id,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailDomainResponse
+
+      def update: (
+        String id,
+        ?dmarc_policy: Telnyx::EmailDmarcPolicy?,
+        ?inbound_enabled: bool,
+        ?tracking: Telnyx::DomainsTrackingSettings,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailDomainResponse
+
+      def list: (
+        ?filter_domain: String,
+        ?filter_profile_id: String,
+        ?filter_status: Telnyx::Models::email_domain_status,
+        ?filter_type: Telnyx::Models::email_domain_type,
+        ?filter_usable_for_inbound: bool,
+        ?filter_usable_for_sending: bool,
+        ?page_after: String,
+        ?page_before: String,
+        ?page_number: Integer,
+        ?page_size: Integer,
+        ?sort: Telnyx::Models::EmailDomainListParams::sort,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Internal::DefaultFlatPagination[Telnyx::EmailDomain]
+
+      def delete: (
+        String id,
+        ?force: bool,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailDomainResponse
+
+      def retrieve_dns_records: (
+        String domain_id,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Models::EmailDomainRetrieveDNSRecordsResponse
+
+      def retrieve_health: (
+        String id,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Models::EmailDomainRetrieveHealthResponse
+
+      def verify: (
+        String domain_id,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailDomainResponse
+
+      def initialize: (client: Telnyx::Client) -> void
+    end
+  end
+end

data/sig/telnyx/resources/email_events.rbs

@@ -0,0 +1,23 @@
+module Telnyx
+  module Resources
+    class EmailEvents
+      def list: (
+        ?email_id: String,
+        ?event_type: Telnyx::Models::EmailEventListParams::event_type,
+        ?from: Time,
+        ?page_cursor: String,
+        ?page_size: Integer,
+        ?to: Time,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Models::EmailEventListResponse
+
+      def retrieve_stats: (
+        ?from: Time,
+        ?to: Time,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Models::EmailEventRetrieveStatsResponse
+
+      def initialize: (client: Telnyx::Client) -> void
+    end
+  end
+end

data/sig/telnyx/resources/email_inboxes/drafts.rbs

@@ -0,0 +1,100 @@
+module Telnyx
+  module Resources
+    class EmailInboxes
+      class Drafts
+        def create: (
+          String inbox_id,
+          ?attachments: ::Array[top],
+          ?bcc: ::Array[Telnyx::Models::email_address_input],
+          ?cc: ::Array[Telnyx::Models::email_address_input],
+          ?from_email: String,
+          ?from_name: String,
+          ?headers: ::Hash[Symbol, String],
+          ?html: String,
+          ?html_body: String,
+          ?labels: ::Array[String],
+          ?metadata: top,
+          ?reply_to: String,
+          ?subject: String,
+          ?tags: ::Array[String],
+          ?text: String,
+          ?text_body: String,
+          ?to: ::Array[Telnyx::Models::email_address_input],
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::EmailInboxes::EmailDraftResponse
+
+        def retrieve: (
+          String draft_id,
+          inbox_id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::EmailInboxes::EmailDraftResponse
+
+        def update: (
+          String draft_id,
+          inbox_id: String,
+          ?attachments: ::Array[top],
+          ?bcc: ::Array[Telnyx::Models::email_address_input],
+          ?cc: ::Array[Telnyx::Models::email_address_input],
+          ?from_email: String,
+          ?from_name: String,
+          ?headers: ::Hash[Symbol, String],
+          ?html: String,
+          ?html_body: String,
+          ?labels: ::Array[String],
+          ?metadata: top,
+          ?reply_to: String,
+          ?subject: String,
+          ?tags: ::Array[String],
+          ?text: String,
+          ?text_body: String,
+          ?to: ::Array[Telnyx::Models::email_address_input],
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::EmailInboxes::EmailDraftResponse
+
+        def list: (
+          String inbox_id,
+          ?filter_status: Telnyx::Models::EmailInboxes::DraftListParams::filter_status,
+          ?page_after: String,
+          ?page_size: Integer,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::Models::EmailInboxes::DraftListResponse
+
+        def delete: (
+          String draft_id,
+          inbox_id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> nil
+
+        def patch: (
+          String draft_id,
+          inbox_id: String,
+          ?attachments: ::Array[top],
+          ?bcc: ::Array[Telnyx::Models::email_address_input],
+          ?cc: ::Array[Telnyx::Models::email_address_input],
+          ?from_email: String,
+          ?from_name: String,
+          ?headers: ::Hash[Symbol, String],
+          ?html: String,
+          ?html_body: String,
+          ?labels: ::Array[String],
+          ?metadata: top,
+          ?reply_to: String,
+          ?subject: String,
+          ?tags: ::Array[String],
+          ?text: String,
+          ?text_body: String,
+          ?to: ::Array[Telnyx::Models::email_address_input],
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::EmailInboxes::EmailDraftResponse
+
+        def send_: (
+          String draft_id,
+          inbox_id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::EmailInboxes::EmailMessageResponse
+
+        def initialize: (client: Telnyx::Client) -> void
+      end
+    end
+  end
+end

data/sig/telnyx/resources/email_inboxes/filters.rbs

@@ -0,0 +1,35 @@
+module Telnyx
+  module Resources
+    class EmailInboxes
+      class Filters
+        def list: (
+          String inbox_id,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::Models::EmailInboxes::FilterListResponse
+
+        def add: (
+          String inbox_id,
+          entries: ::Array[String],
+          type: Telnyx::Models::EmailInboxes::MutateInboxFiltersRequest::type_,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::Models::EmailInboxes::FilterAddResponse
+
+        def delete_all: (
+          String inbox_id,
+          entries: ::Array[String],
+          type: Telnyx::Models::EmailInboxes::MutateInboxFiltersRequest::type_,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::Models::EmailInboxes::FilterDeleteAllResponse
+
+        def replace: (
+          String inbox_id,
+          ?allowlist: ::Array[String],
+          ?blocklist: ::Array[String],
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::Models::EmailInboxes::FilterReplaceResponse
+
+        def initialize: (client: Telnyx::Client) -> void
+      end
+    end
+  end
+end

data/sig/telnyx/resources/email_inboxes/messages/actions.rbs

@@ -0,0 +1,38 @@
+module Telnyx
+  module Resources
+    class EmailInboxes
+      class Messages
+        class Actions
+          def forward: (
+            String message_id,
+            inbox_id: String,
+            to: Telnyx::Models::EmailInboxes::Messages::ActionForwardParams::to,
+            ?bcc: Telnyx::Models::EmailInboxes::Messages::inbox_action_recipient_input,
+            ?cc: Telnyx::Models::EmailInboxes::Messages::inbox_action_recipient_input,
+            ?html: String,
+            ?text: String,
+            ?request_options: Telnyx::request_opts
+          ) -> Telnyx::EmailInboxes::EmailMessageResponse
+
+          def reply: (
+            String message_id,
+            inbox_id: String,
+            ?html: String,
+            ?text: String,
+            ?request_options: Telnyx::request_opts
+          ) -> Telnyx::EmailInboxes::EmailMessageResponse
+
+          def reply_all: (
+            String message_id,
+            inbox_id: String,
+            ?html: String,
+            ?text: String,
+            ?request_options: Telnyx::request_opts
+          ) -> Telnyx::EmailInboxes::EmailMessageResponse
+
+          def initialize: (client: Telnyx::Client) -> void
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/resources/email_inboxes/messages/labels.rbs

@@ -0,0 +1,25 @@
+module Telnyx
+  module Resources
+    class EmailInboxes
+      class Messages
+        class Labels
+          def create: (
+            String message_id,
+            inbox_id: String,
+            labels: ::Array[String],
+            ?request_options: Telnyx::request_opts
+          ) -> Telnyx::Models::EmailInboxes::Messages::LabelCreateResponse
+
+          def delete_all: (
+            String message_id,
+            inbox_id: String,
+            labels: ::Array[String],
+            ?request_options: Telnyx::request_opts
+          ) -> Telnyx::Models::EmailInboxes::Messages::LabelDeleteAllResponse
+
+          def initialize: (client: Telnyx::Client) -> void
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/resources/email_inboxes/messages.rbs

@@ -0,0 +1,57 @@
+module Telnyx
+  module Resources
+    class EmailInboxes
+      class Messages
+        attr_reader actions: Telnyx::Resources::EmailInboxes::Messages::Actions
+
+        attr_reader labels: Telnyx::Resources::EmailInboxes::Messages::Labels
+
+        def update: (
+          String message_id,
+          inbox_id: String,
+          read_at: Telnyx::Models::EmailInboxes::MessageUpdateParams::read_at?,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::Models::EmailInboxes::MessageUpdateResponse
+
+        def list: (
+          String inbox_id,
+          ?filter_from: String,
+          ?filter_label: String,
+          ?filter_read: bool,
+          ?filter_received_after: Time,
+          ?filter_received_before: Time,
+          ?filter_search: String,
+          ?filter_subject: String,
+          ?filter_unread: bool,
+          ?page_after: String,
+          ?page_size: Integer,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::Models::EmailInboxes::MessageListResponse
+
+        def drafts: (
+          String message_id,
+          inbox_id: String,
+          ?attachments: ::Array[top],
+          ?bcc: ::Array[Telnyx::Models::email_address_input],
+          ?cc: ::Array[Telnyx::Models::email_address_input],
+          ?from_email: String,
+          ?from_name: String,
+          ?headers: ::Hash[Symbol, String],
+          ?html: String,
+          ?html_body: String,
+          ?labels: ::Array[String],
+          ?metadata: top,
+          ?reply_to: String,
+          ?subject: String,
+          ?tags: ::Array[String],
+          ?text: String,
+          ?text_body: String,
+          ?to: ::Array[Telnyx::Models::email_address_input],
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::EmailInboxes::EmailDraftResponse
+
+        def initialize: (client: Telnyx::Client) -> void
+      end
+    end
+  end
+end

data/sig/telnyx/resources/email_inboxes/threads/labels.rbs

@@ -0,0 +1,25 @@
+module Telnyx
+  module Resources
+    class EmailInboxes
+      class Threads
+        class Labels
+          def create: (
+            String thread_id,
+            inbox_id: String,
+            labels: ::Array[String],
+            ?request_options: Telnyx::request_opts
+          ) -> Telnyx::Models::EmailInboxes::Threads::LabelCreateResponse
+
+          def delete_all: (
+            String thread_id,
+            inbox_id: String,
+            labels: ::Array[String],
+            ?request_options: Telnyx::request_opts
+          ) -> Telnyx::Models::EmailInboxes::Threads::LabelDeleteAllResponse
+
+          def initialize: (client: Telnyx::Client) -> void
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/resources/email_inboxes/threads.rbs

@@ -0,0 +1,27 @@
+module Telnyx
+  module Resources
+    class EmailInboxes
+      class Threads
+        attr_reader labels: Telnyx::Resources::EmailInboxes::Threads::Labels
+
+        def retrieve: (
+          String thread_id,
+          inbox_id: String,
+          ?page_after: String,
+          ?page_size: Integer,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::Models::EmailInboxes::ThreadRetrieveResponse
+
+        def list: (
+          String inbox_id,
+          ?filter_label: String,
+          ?page_after: String,
+          ?page_size: Integer,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::EmailInboxes::InboundThreadListResponse
+
+        def initialize: (client: Telnyx::Client) -> void
+      end
+    end
+  end
+end

data/sig/telnyx/resources/email_inboxes.rbs

@@ -0,0 +1,34 @@
+module Telnyx
+  module Resources
+    class EmailInboxes
+      attr_reader drafts: Telnyx::Resources::EmailInboxes::Drafts
+
+      attr_reader filters: Telnyx::Resources::EmailInboxes::Filters
+
+      attr_reader messages: Telnyx::Resources::EmailInboxes::Messages
+
+      attr_reader threads: Telnyx::Resources::EmailInboxes::Threads
+
+      def create: (
+        ?domain_id: String,
+        ?username: String,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailInboxResponse
+
+      def retrieve: (
+        String id,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailInboxResponse
+
+      def list: (
+        ?page_cursor: String,
+        ?page_size: Integer,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Models::EmailInboxListResponse
+
+      def delete: (String id, ?request_options: Telnyx::request_opts) -> nil
+
+      def initialize: (client: Telnyx::Client) -> void
+    end
+  end
+end

data/sig/telnyx/resources/email_messages/recipients.rbs

@@ -0,0 +1,24 @@
+module Telnyx
+  module Resources
+    class EmailMessages
+      class Recipients
+        def retrieve: (
+          String recipient_id,
+          email_id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::Models::EmailMessages::RecipientRetrieveResponse
+
+        def list: (
+          String email_id,
+          ?kind: Telnyx::Models::EmailMessages::RecipientListParams::kind,
+          ?page_cursor: String,
+          ?page_size: Integer,
+          ?status: Telnyx::Models::EmailMessages::RecipientListParams::status,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::Models::EmailMessages::RecipientListResponse
+
+        def initialize: (client: Telnyx::Client) -> void
+      end
+    end
+  end
+end

data/sig/telnyx/resources/email_messages.rbs

@@ -0,0 +1,76 @@
+module Telnyx
+  module Resources
+    class EmailMessages
+      attr_reader recipients: Telnyx::Resources::EmailMessages::Recipients
+
+      def create: (
+        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
+      ) -> Telnyx::EmailInboxes::EmailMessageResponse
+
+      def retrieve: (
+        String id,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Models::EmailMessageRetrieveResponse
+
+      def list: (
+        ?page_cursor: String,
+        ?page_size: Integer,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Models::EmailMessageListResponse
+
+      def delete: (String id, ?request_options: Telnyx::request_opts) -> nil
+
+      def batch: (
+        messages: ::Array[Telnyx::EmailMessageBatchParams::Message],
+        ?sandbox_mode: bool,
+        ?idempotency_key: String,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Models::EmailMessageBatchResponse
+
+      def delete_all: (
+        address: String,
+        ?request_options: Telnyx::request_opts
+      ) -> nil
+
+      def delete_schedule: (
+        String email_id,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailInboxes::EmailMessageResponse
+
+      def retrieve_events: (
+        String email_id,
+        ?page_cursor: String,
+        ?page_size: Integer,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Models::EmailMessageRetrieveEventsResponse
+
+      def initialize: (client: Telnyx::Client) -> void
+    end
+  end
+end

data/sig/telnyx/resources/email_templates.rbs

@@ -0,0 +1,56 @@
+module Telnyx
+  module Resources
+    class EmailTemplates
+      def create: (
+        name: String,
+        ?html_body: String?,
+        ?subject: String?,
+        ?text_body: String?,
+        ?variables: ::Array[String],
+        ?idempotency_key: String,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailTemplateResponse
+
+      def retrieve: (
+        String id,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailTemplateResponse
+
+      def update: (
+        String id,
+        ?html_body: String?,
+        ?name: String,
+        ?subject: String?,
+        ?text_body: String?,
+        ?variables: ::Array[String],
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailTemplateResponse
+
+      def list: (
+        ?page_cursor: String,
+        ?page_size: Integer,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Models::EmailTemplateListResponse
+
+      def delete: (String id, ?request_options: Telnyx::request_opts) -> nil
+
+      def render: (
+        String id,
+        ?template_variables: ::Hash[Symbol, top],
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Models::EmailTemplateRenderResponse
+
+      def replace: (
+        String id,
+        ?html_body: String?,
+        ?name: String,
+        ?subject: String?,
+        ?text_body: String?,
+        ?variables: ::Array[String],
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailTemplateResponse
+
+      def initialize: (client: Telnyx::Client) -> void
+    end
+  end
+end

data/sig/telnyx/resources/email_threads.rbs

@@ -0,0 +1,23 @@
+module Telnyx
+  module Resources
+    class EmailThreads
+      def retrieve: (
+        String thread_id,
+        inbox_id: String,
+        ?page_after: String,
+        ?page_size: Integer,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Models::EmailThreadRetrieveResponse
+
+      def list: (
+        ?filter_inbox_id: ::Array[String],
+        ?filter_label: String,
+        ?page_after: String,
+        ?page_size: Integer,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::EmailInboxes::InboundThreadListResponse
+
+      def initialize: (client: Telnyx::Client) -> void
+    end
+  end
+end

data/sig/telnyx/resources/email_unsubscribe_groups/suppressions.rbs

@@ -0,0 +1,28 @@
+module Telnyx
+  module Resources
+    class EmailUnsubscribeGroups
+      class Suppressions
+        def create: (
+          String id,
+          to: String,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::EmailBlockResponse
+
+        def list: (
+          String id,
+          ?page_number: Integer,
+          ?page_size: Integer,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::Internal::DefaultFlatPagination[Telnyx::EmailBlock]
+
+        def delete: (
+          String email,
+          id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> nil
+
+        def initialize: (client: Telnyx::Client) -> void
+      end
+    end
+  end
+end

data/sig/telnyx/resources/email_unsubscribe_groups.rbs

@@ -0,0 +1,39 @@
+module Telnyx
+  module Resources
+    class EmailUnsubscribeGroups
+      attr_reader suppressions: Telnyx::Resources::EmailUnsubscribeGroups::Suppressions
+
+      def create: (
+        name: String,
+        ?description: String?,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::UnsubscribeGroupResponse
+
+      def retrieve: (
+        String id,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::UnsubscribeGroupResponse
+
+      def update: (
+        String id,
+        ?description: String?,
+        ?name: String,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::UnsubscribeGroupResponse
+
+      def list: (
+        ?page_number: Integer,
+        ?page_size: Integer,
+        ?request_options: Telnyx::request_opts
+      ) -> Telnyx::Internal::DefaultFlatPagination[Telnyx::UnsubscribeGroup]
+
+      def delete: (
+        String id,
+        ?force: Telnyx::Models::EmailUnsubscribeGroupDeleteParams::force,
+        ?request_options: Telnyx::request_opts
+      ) -> nil
+
+      def initialize: (client: Telnyx::Client) -> void
+    end
+  end
+end