telnyx 5.158.0 → 5.159.0

data/sig/telnyx/models/email_blocks/email_block_import_response.rbs

@@ -0,0 +1,165 @@
+module Telnyx
+  module Models
+    class EmailBlockImportResponse = EmailBlocks::EmailBlockImportResponse
+
+    module EmailBlocks
+      type email_block_import_response =
+        { data: Telnyx::EmailBlocks::EmailBlockImportResponse::Data }
+
+      class EmailBlockImportResponse < Telnyx::Internal::Type::BaseModel
+        attr_accessor data: Telnyx::EmailBlocks::EmailBlockImportResponse::Data
+
+        def initialize: (
+          data: Telnyx::EmailBlocks::EmailBlockImportResponse::Data
+        ) -> void
+
+        def to_hash: -> {
+          data: Telnyx::EmailBlocks::EmailBlockImportResponse::Data
+        }
+
+        type data =
+          {
+            id: String,
+            created_at: Time,
+            record_type: Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::record_type,
+            status: Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::status,
+            total: Integer,
+            updated_at: Time,
+            completed_at: Time,
+            created_count: Integer,
+            error_count: Integer,
+            errors: ::Hash[Symbol, String],
+            existing_count: Integer,
+            failure_reason: String,
+            processed_rows: Integer,
+            provider: Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::provider,
+            skipped_count: Integer
+          }
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor created_at: Time
+
+          attr_accessor record_type: Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::record_type
+
+          attr_accessor status: Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::status
+
+          attr_accessor total: Integer
+
+          attr_accessor updated_at: Time
+
+          attr_reader completed_at: Time?
+
+          def completed_at=: (Time) -> Time
+
+          attr_reader created_count: Integer?
+
+          def created_count=: (Integer) -> Integer
+
+          attr_reader error_count: Integer?
+
+          def error_count=: (Integer) -> Integer
+
+          attr_reader errors: ::Hash[Symbol, String]?
+
+          def errors=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+          attr_reader existing_count: Integer?
+
+          def existing_count=: (Integer) -> Integer
+
+          attr_reader failure_reason: String?
+
+          def failure_reason=: (String) -> String
+
+          attr_reader processed_rows: Integer?
+
+          def processed_rows=: (Integer) -> Integer
+
+          attr_reader provider: Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::provider?
+
+          def provider=: (
+            Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::provider
+          ) -> Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::provider
+
+          attr_reader skipped_count: Integer?
+
+          def skipped_count=: (Integer) -> Integer
+
+          def initialize: (
+            id: String,
+            created_at: Time,
+            record_type: Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::record_type,
+            status: Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::status,
+            total: Integer,
+            updated_at: Time,
+            ?completed_at: Time,
+            ?created_count: Integer,
+            ?error_count: Integer,
+            ?errors: ::Hash[Symbol, String],
+            ?existing_count: Integer,
+            ?failure_reason: String,
+            ?processed_rows: Integer,
+            ?provider: Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::provider,
+            ?skipped_count: Integer
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            created_at: Time,
+            record_type: Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::record_type,
+            status: Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::status,
+            total: Integer,
+            updated_at: Time,
+            completed_at: Time,
+            created_count: Integer,
+            error_count: Integer,
+            errors: ::Hash[Symbol, String],
+            existing_count: Integer,
+            failure_reason: String,
+            processed_rows: Integer,
+            provider: Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::provider,
+            skipped_count: Integer
+          }
+
+          type record_type = :email_block_import
+
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            EMAIL_BLOCK_IMPORT: :email_block_import
+
+            def self?.values: -> ::Array[Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::record_type]
+          end
+
+          type status = :pending | :processing | :completed | :failed
+
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            PENDING: :pending
+            PROCESSING: :processing
+            COMPLETED: :completed
+            FAILED: :failed
+
+            def self?.values: -> ::Array[Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::status]
+          end
+
+          type provider = :sendgrid | :mailgun | :ses | :generic
+
+          module Provider
+            extend Telnyx::Internal::Type::Enum
+
+            SENDGRID: :sendgrid
+            MAILGUN: :mailgun
+            SES: :ses
+            GENERIC: :generic
+
+            def self?.values: -> ::Array[Telnyx::Models::EmailBlocks::EmailBlockImportResponse::Data::provider]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_blocks/import_create_params.rbs

@@ -0,0 +1,32 @@
+module Telnyx
+  module Models
+    module EmailBlocks
+      type import_create_params =
+        { file: Telnyx::Internal::file_input, block_ttl_days: Integer }
+        & Telnyx::Internal::Type::request_parameters
+
+      class ImportCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor file: Telnyx::Internal::file_input
+
+        attr_reader block_ttl_days: Integer?
+
+        def block_ttl_days=: (Integer) -> Integer
+
+        def initialize: (
+          file: Telnyx::Internal::file_input,
+          ?block_ttl_days: Integer,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          file: Telnyx::Internal::file_input,
+          block_ttl_days: Integer,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_blocks/import_retrieve_params.rbs

@@ -0,0 +1,22 @@
+module Telnyx
+  module Models
+    module EmailBlocks
+      type import_retrieve_params =
+        { id: String } & Telnyx::Internal::Type::request_parameters
+
+      class ImportRetrieveParams < 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
+end

data/sig/telnyx/models/email_dmarc_policy.rbs

@@ -0,0 +1,65 @@
+module Telnyx
+  module Models
+    type email_dmarc_policy =
+      {
+        p_: Telnyx::Models::EmailDmarcPolicy::p_,
+        pct: Integer,
+        rua: String?,
+        sp: Telnyx::Models::EmailDmarcPolicy::sp?
+      }
+
+    class EmailDmarcPolicy < Telnyx::Internal::Type::BaseModel
+      attr_reader p_: Telnyx::Models::EmailDmarcPolicy::p_?
+
+      def p_=: (
+        Telnyx::Models::EmailDmarcPolicy::p_
+      ) -> Telnyx::Models::EmailDmarcPolicy::p_
+
+      attr_reader pct: Integer?
+
+      def pct=: (Integer) -> Integer
+
+      attr_accessor rua: String?
+
+      attr_accessor sp: Telnyx::Models::EmailDmarcPolicy::sp?
+
+      def initialize: (
+        ?p_: Telnyx::Models::EmailDmarcPolicy::p_,
+        ?pct: Integer,
+        ?rua: String?,
+        ?sp: Telnyx::Models::EmailDmarcPolicy::sp?
+      ) -> void
+
+      def to_hash: -> {
+        p_: Telnyx::Models::EmailDmarcPolicy::p_,
+        pct: Integer,
+        rua: String?,
+        sp: Telnyx::Models::EmailDmarcPolicy::sp?
+      }
+
+      type p_ = :none | :quarantine | :reject
+
+      module P
+        extend Telnyx::Internal::Type::Enum
+
+        NONE: :none
+        QUARANTINE: :quarantine
+        REJECT: :reject
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailDmarcPolicy::p_]
+      end
+
+      type sp = :none | :quarantine | :reject
+
+      module Sp
+        extend Telnyx::Internal::Type::Enum
+
+        NONE: :none
+        QUARANTINE: :quarantine
+        REJECT: :reject
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailDmarcPolicy::sp]
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_domain.rbs

@@ -0,0 +1,216 @@
+module Telnyx
+  module Models
+    type email_domain =
+      {
+        id: String,
+        created_at: Time,
+        dkim: Telnyx::EmailDomain::Dkim,
+        dmarc_policy: Telnyx::EmailDmarcPolicy?,
+        dns_records: ::Array[Telnyx::DNSRecord],
+        domain: String,
+        inbound: Telnyx::EmailDomain::Inbound,
+        record_type: Telnyx::Models::EmailDomain::record_type,
+        status: Telnyx::Models::email_domain_status,
+        tracking: Telnyx::DomainsTrackingSettings,
+        type: Telnyx::Models::email_domain_type,
+        updated_at: Time,
+        usable_for_inbound: bool,
+        usable_for_sending: bool,
+        verification: Telnyx::EmailDomainVerification,
+        reputation: Telnyx::EmailDomain::Reputation,
+        verified_at: Time?
+      }
+
+    class EmailDomain < Telnyx::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor dkim: Telnyx::EmailDomain::Dkim
+
+      attr_accessor dmarc_policy: Telnyx::EmailDmarcPolicy?
+
+      attr_accessor dns_records: ::Array[Telnyx::DNSRecord]
+
+      attr_accessor domain: String
+
+      attr_accessor inbound: Telnyx::EmailDomain::Inbound
+
+      attr_accessor record_type: Telnyx::Models::EmailDomain::record_type
+
+      attr_accessor status: Telnyx::Models::email_domain_status
+
+      attr_accessor tracking: Telnyx::DomainsTrackingSettings
+
+      attr_accessor type: Telnyx::Models::email_domain_type
+
+      attr_accessor updated_at: Time
+
+      attr_accessor usable_for_inbound: bool
+
+      attr_accessor usable_for_sending: bool
+
+      attr_accessor verification: Telnyx::EmailDomainVerification
+
+      attr_reader reputation: Telnyx::EmailDomain::Reputation?
+
+      def reputation=: (
+        Telnyx::EmailDomain::Reputation
+      ) -> Telnyx::EmailDomain::Reputation
+
+      attr_accessor verified_at: Time?
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        dkim: Telnyx::EmailDomain::Dkim,
+        dmarc_policy: Telnyx::EmailDmarcPolicy?,
+        dns_records: ::Array[Telnyx::DNSRecord],
+        domain: String,
+        inbound: Telnyx::EmailDomain::Inbound,
+        record_type: Telnyx::Models::EmailDomain::record_type,
+        status: Telnyx::Models::email_domain_status,
+        tracking: Telnyx::DomainsTrackingSettings,
+        type: Telnyx::Models::email_domain_type,
+        updated_at: Time,
+        usable_for_inbound: bool,
+        usable_for_sending: bool,
+        verification: Telnyx::EmailDomainVerification,
+        ?reputation: Telnyx::EmailDomain::Reputation,
+        ?verified_at: Time?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        dkim: Telnyx::EmailDomain::Dkim,
+        dmarc_policy: Telnyx::EmailDmarcPolicy?,
+        dns_records: ::Array[Telnyx::DNSRecord],
+        domain: String,
+        inbound: Telnyx::EmailDomain::Inbound,
+        record_type: Telnyx::Models::EmailDomain::record_type,
+        status: Telnyx::Models::email_domain_status,
+        tracking: Telnyx::DomainsTrackingSettings,
+        type: Telnyx::Models::email_domain_type,
+        updated_at: Time,
+        usable_for_inbound: bool,
+        usable_for_sending: bool,
+        verification: Telnyx::EmailDomainVerification,
+        reputation: Telnyx::EmailDomain::Reputation,
+        verified_at: Time?
+      }
+
+      type dkim =
+        {
+          active: bool,
+          algorithm: Telnyx::Models::EmailDomain::Dkim::algorithm?,
+          key_length: Telnyx::Models::EmailDomain::Dkim::key_length?,
+          rotated_at: Time?,
+          selector: String?
+        }
+
+      class Dkim < Telnyx::Internal::Type::BaseModel
+        attr_accessor active: bool
+
+        attr_accessor algorithm: Telnyx::Models::EmailDomain::Dkim::algorithm?
+
+        attr_accessor key_length: Telnyx::Models::EmailDomain::Dkim::key_length?
+
+        attr_accessor rotated_at: Time?
+
+        attr_accessor selector: String?
+
+        def initialize: (
+          active: bool,
+          algorithm: Telnyx::Models::EmailDomain::Dkim::algorithm?,
+          key_length: Telnyx::Models::EmailDomain::Dkim::key_length?,
+          rotated_at: Time?,
+          selector: String?
+        ) -> void
+
+        def to_hash: -> {
+          active: bool,
+          algorithm: Telnyx::Models::EmailDomain::Dkim::algorithm?,
+          key_length: Telnyx::Models::EmailDomain::Dkim::key_length?,
+          rotated_at: Time?,
+          selector: String?
+        }
+
+        type algorithm = :"rsa-sha256"
+
+        module Algorithm
+          extend Telnyx::Internal::Type::Enum
+
+          RSA_SHA256: :"rsa-sha256"
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailDomain::Dkim::algorithm]
+        end
+
+        type key_length = 2048
+
+        module KeyLength
+          extend Telnyx::Internal::Type::Enum
+
+          KEY_LENGTH_2048: 2048
+
+          def self?.values: -> ::Array[Telnyx::Models::EmailDomain::Dkim::key_length]
+        end
+      end
+
+      type inbound = { catch_all: bool, enabled: bool, mx_required: bool }
+
+      class Inbound < Telnyx::Internal::Type::BaseModel
+        attr_accessor catch_all: bool
+
+        attr_accessor enabled: bool
+
+        attr_accessor mx_required: bool
+
+        def initialize: (
+          catch_all: bool,
+          enabled: bool,
+          mx_required: bool
+        ) -> void
+
+        def to_hash: -> { catch_all: bool, enabled: bool, mx_required: bool }
+      end
+
+      type record_type = :email_domain
+
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        EMAIL_DOMAIN: :email_domain
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailDomain::record_type]
+      end
+
+      type reputation =
+        { band: String, breakdown: ::Hash[Symbol, top], computed_at: Time? }
+
+      class Reputation < Telnyx::Internal::Type::BaseModel
+        attr_reader band: String?
+
+        def band=: (String) -> String
+
+        attr_reader breakdown: ::Hash[Symbol, top]?
+
+        def breakdown=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_accessor computed_at: Time?
+
+        def initialize: (
+          ?band: String,
+          ?breakdown: ::Hash[Symbol, top],
+          ?computed_at: Time?
+        ) -> void
+
+        def to_hash: -> {
+          band: String,
+          breakdown: ::Hash[Symbol, top],
+          computed_at: Time?
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/email_domain_create_params.rbs

@@ -0,0 +1,47 @@
+module Telnyx
+  module Models
+    type email_domain_create_params =
+      {
+        domain: String,
+        dmarc_policy: Telnyx::EmailDmarcPolicy?,
+        inbound_enabled: bool,
+        tracking: Telnyx::DomainsTrackingSettings
+      }
+      & Telnyx::Internal::Type::request_parameters
+
+    class EmailDomainCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor domain: String
+
+      attr_accessor dmarc_policy: Telnyx::EmailDmarcPolicy?
+
+      attr_reader inbound_enabled: bool?
+
+      def inbound_enabled=: (bool) -> bool
+
+      attr_reader tracking: Telnyx::DomainsTrackingSettings?
+
+      def tracking=: (
+        Telnyx::DomainsTrackingSettings
+      ) -> Telnyx::DomainsTrackingSettings
+
+      def initialize: (
+        domain: String,
+        ?dmarc_policy: Telnyx::EmailDmarcPolicy?,
+        ?inbound_enabled: bool,
+        ?tracking: Telnyx::DomainsTrackingSettings,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        domain: String,
+        dmarc_policy: Telnyx::EmailDmarcPolicy?,
+        inbound_enabled: bool,
+        tracking: Telnyx::DomainsTrackingSettings,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_domain_delete_params.rbs

@@ -0,0 +1,29 @@
+module Telnyx
+  module Models
+    type email_domain_delete_params =
+      { id: String, force: bool } & Telnyx::Internal::Type::request_parameters
+
+    class EmailDomainDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_reader force: bool?
+
+      def force=: (bool) -> bool
+
+      def initialize: (
+        id: String,
+        ?force: bool,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        force: bool,
+        request_options: Telnyx::RequestOptions
+      }
+    end
+  end
+end

data/sig/telnyx/models/email_domain_list_params.rbs

@@ -0,0 +1,117 @@
+module Telnyx
+  module Models
+    type email_domain_list_params =
+      {
+        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
+      }
+      & Telnyx::Internal::Type::request_parameters
+
+    class EmailDomainListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_reader filter_domain: String?
+
+      def filter_domain=: (String) -> String
+
+      attr_reader filter_profile_id: String?
+
+      def filter_profile_id=: (String) -> String
+
+      attr_reader filter_status: Telnyx::Models::email_domain_status?
+
+      def filter_status=: (
+        Telnyx::Models::email_domain_status
+      ) -> Telnyx::Models::email_domain_status
+
+      attr_reader filter_type: Telnyx::Models::email_domain_type?
+
+      def filter_type=: (
+        Telnyx::Models::email_domain_type
+      ) -> Telnyx::Models::email_domain_type
+
+      attr_reader filter_usable_for_inbound: bool?
+
+      def filter_usable_for_inbound=: (bool) -> bool
+
+      attr_reader filter_usable_for_sending: bool?
+
+      def filter_usable_for_sending=: (bool) -> bool
+
+      attr_reader page_after: String?
+
+      def page_after=: (String) -> String
+
+      attr_reader page_before: String?
+
+      def page_before=: (String) -> 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::EmailDomainListParams::sort?
+
+      def sort=: (
+        Telnyx::Models::EmailDomainListParams::sort
+      ) -> Telnyx::Models::EmailDomainListParams::sort
+
+      def initialize: (
+        ?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
+      ) -> void
+
+      def to_hash: -> {
+        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::RequestOptions
+      }
+
+      type sort = :created_at | :"-created_at" | :domain | :"-domain"
+
+      module Sort
+        extend Telnyx::Internal::Type::Enum
+
+        CREATED_AT: :created_at
+        CREATED_AT_DESC: :"-created_at"
+        DOMAIN: :domain
+        MINUS_DOMAIN: :"-domain"
+
+        def self?.values: -> ::Array[Telnyx::Models::EmailDomainListParams::sort]
+      end
+    end
+  end
+end