telnyx 5.158.0 → 5.159.0

data/sig/telnyx/models/email_domains/webhook_list_params.rbs

@@ -0,0 +1,62 @@
+module Telnyx
+  module Models
+    module EmailDomains
+      type webhook_list_params =
+        {
+          domain_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          sort: Telnyx::Models::EmailDomains::WebhookListParams::sort
+        }
+        & Telnyx::Internal::Type::request_parameters
+
+      class WebhookListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor domain_id: String
+
+        attr_reader page_number: Integer?
+
+        def page_number=: (Integer) -> Integer
+
+        attr_reader page_size: Integer?
+
+        def page_size=: (Integer) -> Integer
+
+        attr_reader sort: Telnyx::Models::EmailDomains::WebhookListParams::sort?
+
+        def sort=: (
+          Telnyx::Models::EmailDomains::WebhookListParams::sort
+        ) -> Telnyx::Models::EmailDomains::WebhookListParams::sort
+
+        def initialize: (
+          domain_id: String,
+          ?page_number: Integer,
+          ?page_size: Integer,
+          ?sort: Telnyx::Models::EmailDomains::WebhookListParams::sort,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          domain_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          sort: Telnyx::Models::EmailDomains::WebhookListParams::sort,
+          request_options: Telnyx::RequestOptions
+        }
+
+        type sort = :created_at | :"-created_at"
+
+        module Sort
+          extend Telnyx::Internal::Type::Enum
+
+          CREATED_AT: :created_at
+          CREATED_AT_DESC: :"-created_at"
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailDomains::WebhookListParams::sort]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_domains/webhook_retrieve_params.rbs

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

data/sig/telnyx/models/email_domains/webhook_update_params.rbs

@@ -0,0 +1,49 @@
+module Telnyx
+  module Models
+    module EmailDomains
+      type webhook_update_params =
+        {
+          domain_id: String,
+          id: String,
+          events: ::Array[Telnyx::Models::EmailDomains::email_webhook_event],
+          url: String
+        }
+        & Telnyx::Internal::Type::request_parameters
+
+      class WebhookUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor domain_id: String
+
+        attr_accessor id: String
+
+        attr_reader events: ::Array[Telnyx::Models::EmailDomains::email_webhook_event]?
+
+        def events=: (
+          ::Array[Telnyx::Models::EmailDomains::email_webhook_event]
+        ) -> ::Array[Telnyx::Models::EmailDomains::email_webhook_event]
+
+        attr_reader url: String?
+
+        def url=: (String) -> String
+
+        def initialize: (
+          domain_id: String,
+          id: String,
+          ?events: ::Array[Telnyx::Models::EmailDomains::email_webhook_event],
+          ?url: String,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          domain_id: String,
+          id: String,
+          events: ::Array[Telnyx::Models::EmailDomains::email_webhook_event],
+          url: String,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_event_list_params.rbs

@@ -0,0 +1,75 @@
+module Telnyx
+  module Models
+    type email_event_list_params =
+      {
+        email_id: String,
+        event_type: Telnyx::Models::EmailEventListParams::event_type,
+        from: Time,
+        page_cursor: String,
+        page_size: Integer,
+        to: Time
+      }
+      & Telnyx::Internal::Type::request_parameters
+
+    class EmailEventListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_reader email_id: String?
+
+      def email_id=: (String) -> String
+
+      attr_reader event_type: Telnyx::Models::EmailEventListParams::event_type?
+
+      def event_type=: (
+        Telnyx::Models::EmailEventListParams::event_type
+      ) -> Telnyx::Models::EmailEventListParams::event_type
+
+      attr_reader from: Time?
+
+      def from=: (Time) -> Time
+
+      attr_reader page_cursor: String?
+
+      def page_cursor=: (String) -> String
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      attr_reader to: Time?
+
+      def to=: (Time) -> Time
+
+      def initialize: (
+        ?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
+      ) -> void
+
+      def to_hash: -> {
+        email_id: String,
+        event_type: Telnyx::Models::EmailEventListParams::event_type,
+        from: Time,
+        page_cursor: String,
+        page_size: Integer,
+        to: Time,
+        request_options: Telnyx::RequestOptions
+      }
+
+      type event_type = String | ::Array[String]
+
+      module EventType
+        extend Telnyx::Internal::Type::Union
+
+        def self?.variants: -> ::Array[Telnyx::Models::EmailEventListParams::event_type]
+
+        StringArray: Telnyx::Internal::Type::Converter
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_event_list_response.rbs

@@ -0,0 +1,149 @@
+module Telnyx
+  module Models
+    type email_event_list_response =
+      {
+        data: ::Array[Telnyx::Models::EmailEventListResponse::Data],
+        meta: Telnyx::Models::EmailEventListResponse::Meta
+      }
+
+    class EmailEventListResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: ::Array[Telnyx::Models::EmailEventListResponse::Data]
+
+      attr_accessor meta: Telnyx::Models::EmailEventListResponse::Meta
+
+      def initialize: (
+        data: ::Array[Telnyx::Models::EmailEventListResponse::Data],
+        meta: Telnyx::Models::EmailEventListResponse::Meta
+      ) -> void
+
+      def to_hash: -> {
+        data: ::Array[Telnyx::Models::EmailEventListResponse::Data],
+        meta: Telnyx::Models::EmailEventListResponse::Meta
+      }
+
+      type data =
+        {
+          id: String,
+          email_id: String,
+          occurred_at: Time,
+          record_type: Telnyx::Models::EmailEventListResponse::Data::record_type,
+          type: Telnyx::Models::email_event_type,
+          email: Telnyx::Models::EmailEventListResponse::Data::Email,
+          payload: ::Hash[Symbol, top]
+        }
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor email_id: String
+
+        attr_accessor occurred_at: Time
+
+        attr_accessor record_type: Telnyx::Models::EmailEventListResponse::Data::record_type
+
+        attr_accessor type: Telnyx::Models::email_event_type
+
+        attr_reader email: Telnyx::Models::EmailEventListResponse::Data::Email?
+
+        def email=: (
+          Telnyx::Models::EmailEventListResponse::Data::Email
+        ) -> Telnyx::Models::EmailEventListResponse::Data::Email
+
+        attr_reader payload: ::Hash[Symbol, top]?
+
+        def payload=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        def initialize: (
+          id: String,
+          email_id: String,
+          occurred_at: Time,
+          record_type: Telnyx::Models::EmailEventListResponse::Data::record_type,
+          type: Telnyx::Models::email_event_type,
+          ?email: Telnyx::Models::EmailEventListResponse::Data::Email,
+          ?payload: ::Hash[Symbol, top]
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          email_id: String,
+          occurred_at: Time,
+          record_type: Telnyx::Models::EmailEventListResponse::Data::record_type,
+          type: Telnyx::Models::email_event_type,
+          email: Telnyx::Models::EmailEventListResponse::Data::Email,
+          payload: ::Hash[Symbol, top]
+        }
+
+        type record_type = :email_event
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_EVENT: :email_event
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailEventListResponse::Data::record_type]
+        end
+
+        type email =
+          {
+            cc: ::Array[Telnyx::EmailInboxes::EmailAddress],
+            from: Telnyx::EmailInboxes::EmailAddress,
+            subject: String,
+            to: ::Array[Telnyx::EmailInboxes::EmailAddress]
+          }
+
+        class Email < Telnyx::Internal::Type::BaseModel
+          attr_accessor cc: ::Array[Telnyx::EmailInboxes::EmailAddress]
+
+          attr_accessor from: Telnyx::EmailInboxes::EmailAddress
+
+          attr_accessor subject: String
+
+          attr_accessor to: ::Array[Telnyx::EmailInboxes::EmailAddress]
+
+          def initialize: (
+            cc: ::Array[Telnyx::EmailInboxes::EmailAddress],
+            from: Telnyx::EmailInboxes::EmailAddress,
+            subject: String,
+            to: ::Array[Telnyx::EmailInboxes::EmailAddress]
+          ) -> void
+
+          def to_hash: -> {
+            cc: ::Array[Telnyx::EmailInboxes::EmailAddress],
+            from: Telnyx::EmailInboxes::EmailAddress,
+            subject: String,
+            to: ::Array[Telnyx::EmailInboxes::EmailAddress]
+          }
+        end
+      end
+
+      type meta =
+        {
+          page_size: Integer,
+          time_range: Telnyx::TimeRange,
+          page_cursor: String
+        }
+
+      class Meta < Telnyx::Internal::Type::BaseModel
+        attr_accessor page_size: Integer
+
+        attr_accessor time_range: Telnyx::TimeRange
+
+        attr_reader page_cursor: String?
+
+        def page_cursor=: (String) -> String
+
+        def initialize: (
+          page_size: Integer,
+          time_range: Telnyx::TimeRange,
+          ?page_cursor: String
+        ) -> void
+
+        def to_hash: -> {
+          page_size: Integer,
+          time_range: Telnyx::TimeRange,
+          page_cursor: String
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_event_retrieve_stats_params.rbs

@@ -0,0 +1,31 @@
+module Telnyx
+  module Models
+    type email_event_retrieve_stats_params =
+      { from: Time, to: Time } & Telnyx::Internal::Type::request_parameters
+
+    class EmailEventRetrieveStatsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_reader from: Time?
+
+      def from=: (Time) -> Time
+
+      attr_reader to: Time?
+
+      def to=: (Time) -> Time
+
+      def initialize: (
+        ?from: Time,
+        ?to: Time,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        from: Time,
+        to: Time,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_event_retrieve_stats_response.rbs

@@ -0,0 +1,164 @@
+module Telnyx
+  module Models
+    type email_event_retrieve_stats_response =
+      { data: Telnyx::Models::EmailEventRetrieveStatsResponse::Data }
+
+    class EmailEventRetrieveStatsResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: Telnyx::Models::EmailEventRetrieveStatsResponse::Data
+
+      def initialize: (
+        data: Telnyx::Models::EmailEventRetrieveStatsResponse::Data
+      ) -> void
+
+      def to_hash: -> {
+        data: Telnyx::Models::EmailEventRetrieveStatsResponse::Data
+      }
+
+      type data =
+        {
+          counts: Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Counts,
+          rates: Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Rates,
+          record_type: Telnyx::Models::EmailEventRetrieveStatsResponse::Data::record_type,
+          time_range: Telnyx::TimeRange
+        }
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        attr_accessor counts: Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Counts
+
+        attr_accessor rates: Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Rates
+
+        attr_accessor record_type: Telnyx::Models::EmailEventRetrieveStatsResponse::Data::record_type
+
+        attr_accessor time_range: Telnyx::TimeRange
+
+        def initialize: (
+          counts: Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Counts,
+          rates: Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Rates,
+          record_type: Telnyx::Models::EmailEventRetrieveStatsResponse::Data::record_type,
+          time_range: Telnyx::TimeRange
+        ) -> void
+
+        def to_hash: -> {
+          counts: Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Counts,
+          rates: Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Rates,
+          record_type: Telnyx::Models::EmailEventRetrieveStatsResponse::Data::record_type,
+          time_range: Telnyx::TimeRange
+        }
+
+        type counts =
+          {
+            bounced: Integer,
+            clicked: Integer,
+            complained: Integer,
+            deferred: Integer,
+            delivered: Integer,
+            failed: Integer,
+            opened: Integer,
+            queued: Integer,
+            sent: Integer,
+            unsubscribed: Integer
+          }
+
+        class Counts < Telnyx::Internal::Type::BaseModel
+          attr_accessor bounced: Integer
+
+          attr_accessor clicked: Integer
+
+          attr_accessor complained: Integer
+
+          attr_accessor deferred: Integer
+
+          attr_accessor delivered: Integer
+
+          attr_accessor failed: Integer
+
+          attr_accessor opened: Integer
+
+          attr_accessor queued: Integer
+
+          attr_accessor sent: Integer
+
+          attr_accessor unsubscribed: Integer
+
+          def initialize: (
+            bounced: Integer,
+            clicked: Integer,
+            complained: Integer,
+            deferred: Integer,
+            delivered: Integer,
+            failed: Integer,
+            opened: Integer,
+            queued: Integer,
+            sent: Integer,
+            unsubscribed: Integer
+          ) -> void
+
+          def to_hash: -> {
+            bounced: Integer,
+            clicked: Integer,
+            complained: Integer,
+            deferred: Integer,
+            delivered: Integer,
+            failed: Integer,
+            opened: Integer,
+            queued: Integer,
+            sent: Integer,
+            unsubscribed: Integer
+          }
+        end
+
+        type rates =
+          {
+            bounce_rate: Float,
+            click_rate: Float,
+            complaint_rate: Float,
+            deferred_rate: Float,
+            delivery_rate: Float,
+            open_rate: Float
+          }
+
+        class Rates < Telnyx::Internal::Type::BaseModel
+          attr_accessor bounce_rate: Float
+
+          attr_accessor click_rate: Float
+
+          attr_accessor complaint_rate: Float
+
+          attr_accessor deferred_rate: Float
+
+          attr_accessor delivery_rate: Float
+
+          attr_accessor open_rate: Float
+
+          def initialize: (
+            bounce_rate: Float,
+            click_rate: Float,
+            complaint_rate: Float,
+            deferred_rate: Float,
+            delivery_rate: Float,
+            open_rate: Float
+          ) -> void
+
+          def to_hash: -> {
+            bounce_rate: Float,
+            click_rate: Float,
+            complaint_rate: Float,
+            deferred_rate: Float,
+            delivery_rate: Float,
+            open_rate: Float
+          }
+        end
+
+        type record_type = :email_event_stats
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_EVENT_STATS: :email_event_stats
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailEventRetrieveStatsResponse::Data::record_type]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_event_type.rbs

@@ -0,0 +1,44 @@
+module Telnyx
+  module Models
+    type email_event_type =
+      :queued
+      | :deferred
+      | :scheduled
+      | :cancelled
+      | :sandbox
+      | :sending
+      | :sent
+      | :failed
+      | :delivered
+      | :bounced
+      | :complained
+      | :rejected
+      | :opened
+      | :clicked
+      | :unsubscribed
+      | :daily_limit_exceeded
+
+    module EmailEventType
+      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
+      REJECTED: :rejected
+      OPENED: :opened
+      CLICKED: :clicked
+      UNSUBSCRIBED: :unsubscribed
+      DAILY_LIMIT_EXCEEDED: :daily_limit_exceeded
+
+      def self?.values: -> ::Array[Telnyx::Models::email_event_type]
+    end
+  end
+end

data/sig/telnyx/models/email_inbox.rbs

@@ -0,0 +1,81 @@
+module Telnyx
+  module Models
+    type email_inbox =
+      {
+        id: String,
+        address: String,
+        created_at: Time,
+        domain: String,
+        domain_id: String,
+        record_type: Telnyx::Models::EmailInbox::record_type,
+        settings: ::Hash[Symbol, top],
+        status: Telnyx::Models::EmailInbox::status,
+        updated_at: Time
+      }
+
+    class EmailInbox < Telnyx::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor address: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor domain: String
+
+      attr_accessor domain_id: String
+
+      attr_accessor record_type: Telnyx::Models::EmailInbox::record_type
+
+      attr_accessor settings: ::Hash[Symbol, top]
+
+      attr_accessor status: Telnyx::Models::EmailInbox::status
+
+      attr_accessor updated_at: Time
+
+      def initialize: (
+        id: String,
+        address: String,
+        created_at: Time,
+        domain: String,
+        domain_id: String,
+        record_type: Telnyx::Models::EmailInbox::record_type,
+        settings: ::Hash[Symbol, top],
+        status: Telnyx::Models::EmailInbox::status,
+        updated_at: Time
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        address: String,
+        created_at: Time,
+        domain: String,
+        domain_id: String,
+        record_type: Telnyx::Models::EmailInbox::record_type,
+        settings: ::Hash[Symbol, top],
+        status: Telnyx::Models::EmailInbox::status,
+        updated_at: Time
+      }
+
+      type record_type = :email_inbox
+
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        EMAIL_INBOX: :email_inbox
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailInbox::record_type]
+      end
+
+      type status = :active | :paused
+
+      module Status
+        extend Telnyx::Internal::Type::Enum
+
+        ACTIVE: :active
+        PAUSED: :paused
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailInbox::status]
+      end
+    end
+  end
+end