telnyx 5.158.0 → 5.159.0

data/lib/telnyx/models/email_event_retrieve_stats_response.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailEvents#retrieve_stats
+    class EmailEventRetrieveStatsResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::EmailEventRetrieveStatsResponse::Data]
+      required :data, -> { Telnyx::Models::EmailEventRetrieveStatsResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::EmailEventRetrieveStatsResponse::Data]
+
+      # @see Telnyx::Models::EmailEventRetrieveStatsResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute counts
+        #   Recipient-level outcome counts for the queried time range. Each to, cc, and bcc
+        #   recipient counts separately; repeated events of the same type for the same
+        #   message and recipient count once. Partial MTA injection results count successful
+        #   recipients as sent and unsuccessful recipients as failed. Only the ten listed
+        #   event types are counted; other valid event types (scheduled, cancelled, sandbox,
+        #   sending, rejected) are not included in stats.
+        #
+        #   @return [Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Counts]
+        required :counts, -> { Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Counts }
+
+        # @!attribute rates
+        #   Recipient-level event rates as percentages, rounded to 2 decimal places.
+        #
+        #   @return [Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Rates]
+        required :rates, -> { Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Rates }
+
+        # @!attribute record_type
+        #
+        #   @return [Symbol, Telnyx::Models::EmailEventRetrieveStatsResponse::Data::RecordType]
+        required :record_type, enum: -> { Telnyx::Models::EmailEventRetrieveStatsResponse::Data::RecordType }
+
+        # @!attribute time_range
+        #
+        #   @return [Telnyx::Models::TimeRange]
+        required :time_range, -> { Telnyx::TimeRange }
+
+        # @!method initialize(counts:, rates:, record_type:, time_range:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::EmailEventRetrieveStatsResponse::Data} for more details.
+        #
+        #   @param counts [Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Counts] Recipient-level outcome counts for the queried time range. Each to, cc, and bcc
+        #
+        #   @param rates [Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Rates] Recipient-level event rates as percentages, rounded to 2 decimal places.
+        #
+        #   @param record_type [Symbol, Telnyx::Models::EmailEventRetrieveStatsResponse::Data::RecordType]
+        #
+        #   @param time_range [Telnyx::Models::TimeRange]
+
+        # @see Telnyx::Models::EmailEventRetrieveStatsResponse::Data#counts
+        class Counts < Telnyx::Internal::Type::BaseModel
+          # @!attribute bounced
+          #
+          #   @return [Integer]
+          required :bounced, Integer
+
+          # @!attribute clicked
+          #
+          #   @return [Integer]
+          required :clicked, Integer
+
+          # @!attribute complained
+          #
+          #   @return [Integer]
+          required :complained, Integer
+
+          # @!attribute deferred
+          #
+          #   @return [Integer]
+          required :deferred, Integer
+
+          # @!attribute delivered
+          #
+          #   @return [Integer]
+          required :delivered, Integer
+
+          # @!attribute failed
+          #
+          #   @return [Integer]
+          required :failed, Integer
+
+          # @!attribute opened
+          #
+          #   @return [Integer]
+          required :opened, Integer
+
+          # @!attribute queued
+          #
+          #   @return [Integer]
+          required :queued, Integer
+
+          # @!attribute sent
+          #
+          #   @return [Integer]
+          required :sent, Integer
+
+          # @!attribute unsubscribed
+          #
+          #   @return [Integer]
+          required :unsubscribed, Integer
+
+          # @!method initialize(bounced:, clicked:, complained:, deferred:, delivered:, failed:, opened:, queued:, sent:, unsubscribed:)
+          #   Recipient-level outcome counts for the queried time range. Each to, cc, and bcc
+          #   recipient counts separately; repeated events of the same type for the same
+          #   message and recipient count once. Partial MTA injection results count successful
+          #   recipients as sent and unsuccessful recipients as failed. Only the ten listed
+          #   event types are counted; other valid event types (scheduled, cancelled, sandbox,
+          #   sending, rejected) are not included in stats.
+          #
+          #   @param bounced [Integer]
+          #   @param clicked [Integer]
+          #   @param complained [Integer]
+          #   @param deferred [Integer]
+          #   @param delivered [Integer]
+          #   @param failed [Integer]
+          #   @param opened [Integer]
+          #   @param queued [Integer]
+          #   @param sent [Integer]
+          #   @param unsubscribed [Integer]
+        end
+
+        # @see Telnyx::Models::EmailEventRetrieveStatsResponse::Data#rates
+        class Rates < Telnyx::Internal::Type::BaseModel
+          # @!attribute bounce_rate
+          #   Bounced recipients / queued recipients as a percentage.
+          #
+          #   @return [Float]
+          required :bounce_rate, Float
+
+          # @!attribute click_rate
+          #   Recipients clicked / recipients opened as a percentage.
+          #
+          #   @return [Float]
+          required :click_rate, Float
+
+          # @!attribute complaint_rate
+          #   Recipients with a complaint feedback report / delivered recipients as a
+          #   percentage.
+          #
+          #   @return [Float]
+          required :complaint_rate, Float
+
+          # @!attribute deferred_rate
+          #   Deferred recipients / queued recipients as a percentage.
+          #
+          #   @return [Float]
+          required :deferred_rate, Float
+
+          # @!attribute delivery_rate
+          #   Delivered recipients / queued recipients as a percentage.
+          #
+          #   @return [Float]
+          required :delivery_rate, Float
+
+          # @!attribute open_rate
+          #   Recipients opened / recipients delivered as a percentage.
+          #
+          #   @return [Float]
+          required :open_rate, Float
+
+          # @!method initialize(bounce_rate:, click_rate:, complaint_rate:, deferred_rate:, delivery_rate:, open_rate:)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::EmailEventRetrieveStatsResponse::Data::Rates} for more details.
+          #
+          #   Recipient-level event rates as percentages, rounded to 2 decimal places.
+          #
+          #   @param bounce_rate [Float] Bounced recipients / queued recipients as a percentage.
+          #
+          #   @param click_rate [Float] Recipients clicked / recipients opened as a percentage.
+          #
+          #   @param complaint_rate [Float] Recipients with a complaint feedback report / delivered recipients as a percenta
+          #
+          #   @param deferred_rate [Float] Deferred recipients / queued recipients as a percentage.
+          #
+          #   @param delivery_rate [Float] Delivered recipients / queued recipients as a percentage.
+          #
+          #   @param open_rate [Float] Recipients opened / recipients delivered as a percentage.
+        end
+
+        # @see Telnyx::Models::EmailEventRetrieveStatsResponse::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_EVENT_STATS = :email_event_stats
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_event_type.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    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
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/telnyx/models/email_inbox.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class EmailInbox < Telnyx::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute address
+      #
+      #   @return [String]
+      required :address, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute domain
+      #   Domain name used by the inbox address.
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!attribute domain_id
+      #
+      #   @return [String]
+      required :domain_id, String
+
+      # @!attribute record_type
+      #
+      #   @return [Symbol, Telnyx::Models::EmailInbox::RecordType]
+      required :record_type, enum: -> { Telnyx::EmailInbox::RecordType }
+
+      # @!attribute settings
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :settings, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Telnyx::Models::EmailInbox::Status]
+      required :status, enum: -> { Telnyx::EmailInbox::Status }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, address:, created_at:, domain:, domain_id:, record_type:, settings:, status:, updated_at:)
+      #   @param id [String]
+      #
+      #   @param address [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param domain [String] Domain name used by the inbox address.
+      #
+      #   @param domain_id [String]
+      #
+      #   @param record_type [Symbol, Telnyx::Models::EmailInbox::RecordType]
+      #
+      #   @param settings [Hash{Symbol=>Object}]
+      #
+      #   @param status [Symbol, Telnyx::Models::EmailInbox::Status]
+      #
+      #   @param updated_at [Time]
+
+      # @see Telnyx::Models::EmailInbox#record_type
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        EMAIL_INBOX = :email_inbox
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Telnyx::Models::EmailInbox#status
+      module Status
+        extend Telnyx::Internal::Type::Enum
+
+        ACTIVE = :active
+        PAUSED = :paused
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inbox_create_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailInboxes#create
+    class EmailInboxCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute domain_id
+      #   Account-owned, inbound-enabled domain UUID. The account's shared inbound
+      #   subdomain is allocated when omitted.
+      #
+      #   @return [String, nil]
+      optional :domain_id, String
+
+      # @!attribute username
+      #   Inbox local part. Trimmed and lowercased before validation; the normalized value
+      #   must be 1-64 characters, start and end with a letter or digit, and contain only
+      #   letters, digits, dots, hyphens, and underscores. Generated when omitted.
+      #
+      #   @return [String, nil]
+      optional :username, String
+
+      # @!method initialize(domain_id: nil, username: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailInboxCreateParams} for more details.
+      #
+      #   @param domain_id [String] Account-owned, inbound-enabled domain UUID. The account's shared inbound subdoma
+      #
+      #   @param username [String] Inbox local part. Trimmed and lowercased before validation; the normalized value
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_inbox_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailInboxes#delete
+    class EmailInboxDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_inbox_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailInboxes#list
+    class EmailInboxListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute page_cursor
+      #   Opaque cursor returned by the previous inbox page.
+      #
+      #   @return [String, nil]
+      optional :page_cursor, String
+
+      # @!attribute page_size
+      #   Number of results to return. Defaults to 20; maximum is 250.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(page_cursor: nil, page_size: nil, request_options: {})
+      #   @param page_cursor [String] Opaque cursor returned by the previous inbox page.
+      #
+      #   @param page_size [Integer] Number of results to return. Defaults to 20; maximum is 250.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_inbox_list_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailInboxes#list
+    class EmailInboxListResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::EmailInbox>]
+      required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInbox] }
+
+      # @!attribute meta
+      #
+      #   @return [Telnyx::Models::EmailInboxListResponse::Meta]
+      required :meta, -> { Telnyx::Models::EmailInboxListResponse::Meta }
+
+      # @!method initialize(data:, meta:)
+      #   @param data [Array<Telnyx::Models::EmailInbox>]
+      #   @param meta [Telnyx::Models::EmailInboxListResponse::Meta]
+
+      # @see Telnyx::Models::EmailInboxListResponse#meta
+      class Meta < Telnyx::Internal::Type::BaseModel
+        # @!attribute page_size
+        #
+        #   @return [Integer]
+        required :page_size, Integer
+
+        # @!attribute page_cursor
+        #   Cursor for the next inbox page, when more results are available.
+        #
+        #   @return [String, nil]
+        optional :page_cursor, String
+
+        # @!method initialize(page_size:, page_cursor: nil)
+        #   @param page_size [Integer]
+        #
+        #   @param page_cursor [String] Cursor for the next inbox page, when more results are available.
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inbox_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailInboxes#create
+    class EmailInboxResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::EmailInbox]
+      required :data, -> { Telnyx::EmailInbox }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::EmailInbox]
+    end
+  end
+end

data/lib/telnyx/models/email_inbox_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailInboxes#retrieve
+    class EmailInboxRetrieveParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/draft_create_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Drafts#create
+      class DraftCreateParams < Telnyx::Models::EmailInboxes::EmailDraftRequest
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute inbox_id
+        #
+        #   @return [String]
+        required :inbox_id, String
+
+        # @!method initialize(inbox_id:, request_options: {})
+        #   @param inbox_id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/draft_delete_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Drafts#delete
+      class DraftDeleteParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute inbox_id
+        #
+        #   @return [String]
+        required :inbox_id, String
+
+        # @!attribute draft_id
+        #
+        #   @return [String]
+        required :draft_id, String
+
+        # @!method initialize(inbox_id:, draft_id:, request_options: {})
+        #   @param inbox_id [String]
+        #   @param draft_id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/draft_list_params.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Drafts#list
+      class DraftListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute inbox_id
+        #
+        #   @return [String]
+        required :inbox_id, String
+
+        # @!attribute filter_status
+        #   Restrict results to drafts in this state.
+        #
+        #   @return [Symbol, Telnyx::Models::EmailInboxes::DraftListParams::FilterStatus, nil]
+        optional :filter_status, enum: -> { Telnyx::EmailInboxes::DraftListParams::FilterStatus }
+
+        # @!attribute page_after
+        #   Opaque cursor returned by the previous page.
+        #
+        #   @return [String, nil]
+        optional :page_after, String
+
+        # @!attribute page_size
+        #   Number of results to return. Defaults to 25; maximum is 100.
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!method initialize(inbox_id:, filter_status: nil, page_after: nil, page_size: nil, request_options: {})
+        #   @param inbox_id [String]
+        #
+        #   @param filter_status [Symbol, Telnyx::Models::EmailInboxes::DraftListParams::FilterStatus] Restrict results to drafts in this state.
+        #
+        #   @param page_after [String] Opaque cursor returned by the previous page.
+        #
+        #   @param page_size [Integer] Number of results to return. Defaults to 25; maximum is 100.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        # Restrict results to drafts in this state.
+        module FilterStatus
+          extend Telnyx::Internal::Type::Enum
+
+          DRAFT = :draft
+          SENDING = :sending
+          SENT = :sent
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/draft_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Drafts#list
+      class DraftListResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::EmailInboxes::EmailDraft>]
+        required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailDraft] }
+
+        # @!attribute meta
+        #
+        #   @return [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
+        required :meta, -> { Telnyx::EmailInboxes::EmailPaginationMeta }
+
+        # @!method initialize(data:, meta:)
+        #   @param data [Array<Telnyx::Models::EmailInboxes::EmailDraft>]
+        #   @param meta [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/draft_patch_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Drafts#patch
+      class DraftPatchParams < Telnyx::Models::EmailInboxes::EmailDraftRequest
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute inbox_id
+        #
+        #   @return [String]
+        required :inbox_id, String
+
+        # @!attribute draft_id
+        #
+        #   @return [String]
+        required :draft_id, String
+
+        # @!method initialize(inbox_id:, draft_id:, request_options: {})
+        #   @param inbox_id [String]
+        #   @param draft_id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_inboxes/draft_retrieve_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailInboxes
+      # @see Telnyx::Resources::EmailInboxes::Drafts#retrieve
+      class DraftRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute inbox_id
+        #
+        #   @return [String]
+        required :inbox_id, String
+
+        # @!attribute draft_id
+        #
+        #   @return [String]
+        required :draft_id, String
+
+        # @!method initialize(inbox_id:, draft_id:, request_options: {})
+        #   @param inbox_id [String]
+        #   @param draft_id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end