telnyx 5.158.0 → 5.159.0

data/lib/telnyx/models/email_block.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailBlocks#list
+    class EmailBlock < Telnyx::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute reason
+      #
+      #   @return [Symbol, Telnyx::Models::EmailBlock::Reason]
+      required :reason, enum: -> { Telnyx::EmailBlock::Reason }
+
+      # @!attribute record_type
+      #   View-only discriminator.
+      #
+      #   @return [Symbol, Telnyx::Models::EmailBlock::RecordType]
+      required :record_type, enum: -> { Telnyx::EmailBlock::RecordType }
+
+      # @!attribute scope
+      #   Derived server-side from `domain_id`/`from`; never trusted from the caller.
+      #
+      #   @return [Symbol, Telnyx::Models::EmailBlock::Scope]
+      required :scope, enum: -> { Telnyx::EmailBlock::Scope }
+
+      # @!attribute source
+      #
+      #   @return [Symbol, Telnyx::Models::EmailBlock::Source]
+      required :source, enum: -> { Telnyx::EmailBlock::Source }
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Telnyx::Models::EmailBlock::Status]
+      required :status, enum: -> { Telnyx::EmailBlock::Status }
+
+      # @!attribute to
+      #   Normalized recipient. (schema: to_address)
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute domain_id
+      #   `null` ⇒ account scope. Stored on the row; exposed here.
+      #
+      #   @return [String, nil]
+      optional :domain_id, String, nil?: true
+
+      # @!attribute expires_at
+      #
+      #   @return [Time, nil]
+      optional :expires_at, Time, nil?: true
+
+      # @!attribute from
+      #   `null` ⇒ not address-scope. (schema: from_address)
+      #
+      #   @return [String, nil]
+      optional :from, String, nil?: true
+
+      # @!attribute group_id
+      #   `null` ⇒ global; set ⇒ group-scoped opt-out.
+      #
+      #   @return [String, nil]
+      optional :group_id, String, nil?: true
+
+      # @!method initialize(id:, created_at:, reason:, record_type:, scope:, source:, status:, to:, updated_at:, domain_id: nil, expires_at: nil, from: nil, group_id: nil)
+      #   Suppression record. Schema fields hidden by the view: `account_id`,
+      #   `bounce_category`, `dsn_code`, `meta`.
+      #
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param reason [Symbol, Telnyx::Models::EmailBlock::Reason]
+      #
+      #   @param record_type [Symbol, Telnyx::Models::EmailBlock::RecordType] View-only discriminator.
+      #
+      #   @param scope [Symbol, Telnyx::Models::EmailBlock::Scope] Derived server-side from `domain_id`/`from`; never trusted from the caller.
+      #
+      #   @param source [Symbol, Telnyx::Models::EmailBlock::Source]
+      #
+      #   @param status [Symbol, Telnyx::Models::EmailBlock::Status]
+      #
+      #   @param to [String] Normalized recipient. (schema: to_address)
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param domain_id [String, nil] `null` ⇒ account scope. Stored on the row; exposed here.
+      #
+      #   @param expires_at [Time, nil]
+      #
+      #   @param from [String, nil] `null` ⇒ not address-scope. (schema: from_address)
+      #
+      #   @param group_id [String, nil] `null` ⇒ global; set ⇒ group-scoped opt-out.
+
+      # @see Telnyx::Models::EmailBlock#reason
+      module Reason
+        extend Telnyx::Internal::Type::Enum
+
+        HARD_BOUNCE = :hard_bounce
+        SPAM_COMPLAINT = :spam_complaint
+        UNSUBSCRIBE = :unsubscribe
+        INVALID = :invalid
+        MANUAL_BLOCK = :manual_block
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # View-only discriminator.
+      #
+      # @see Telnyx::Models::EmailBlock#record_type
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        EMAIL_BLOCK = :email_block
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Derived server-side from `domain_id`/`from`; never trusted from the caller.
+      #
+      # @see Telnyx::Models::EmailBlock#scope
+      module Scope
+        extend Telnyx::Internal::Type::Enum
+
+        ACCOUNT = :account
+        DOMAIN = :domain
+        ADDRESS = :address
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Telnyx::Models::EmailBlock#source
+      module Source
+        extend Telnyx::Internal::Type::Enum
+
+        FEEDBACK = :feedback
+        MANUAL = :manual
+        IMPORT = :import
+        SYSTEM = :system
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Telnyx::Models::EmailBlock#status
+      module Status
+        extend Telnyx::Internal::Type::Enum
+
+        ACTIVE = :active
+        EXPIRED = :expired
+        REMOVED = :removed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_block_create_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailBlocks#create
+    class EmailBlockCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute to
+      #   Recipient address (normalized: trim + lower-case).
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!attribute domain_id
+      #   `null` ⇒ account scope.
+      #
+      #   @return [String, nil]
+      optional :domain_id, String, nil?: true
+
+      # @!attribute expires_at
+      #
+      #   @return [Time, nil]
+      optional :expires_at, Time, nil?: true
+
+      # @!attribute from
+      #   Sender address (normalized). `null` ⇒ account/domain scope.
+      #
+      #   @return [String, nil]
+      optional :from, String, nil?: true
+
+      # @!method initialize(to:, domain_id: nil, expires_at: nil, from: nil, request_options: {})
+      #   @param to [String] Recipient address (normalized: trim + lower-case).
+      #
+      #   @param domain_id [String, nil] `null` ⇒ account scope.
+      #
+      #   @param expires_at [Time, nil]
+      #
+      #   @param from [String, nil] Sender address (normalized). `null` ⇒ account/domain scope.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_block_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailBlocks#delete
+    class EmailBlockDeleteParams < 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_block_list_params.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailBlocks#list
+    class EmailBlockListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute filter_created_after
+      #   `created_at > value` (ISO 8601).
+      #
+      #   @return [Time, nil]
+      optional :filter_created_after, Time
+
+      # @!attribute filter_created_before
+      #   `created_at < value` (ISO 8601).
+      #
+      #   @return [Time, nil]
+      optional :filter_created_before, Time
+
+      # @!attribute filter_domain_id
+      #   Exact-match filter on domain_id (UUID).
+      #
+      #   @return [String, nil]
+      optional :filter_domain_id, String
+
+      # @!attribute filter_reason
+      #   Exact-match filter on reason.
+      #
+      #   @return [Symbol, Telnyx::Models::EmailBlockListParams::FilterReason, nil]
+      optional :filter_reason, enum: -> { Telnyx::EmailBlockListParams::FilterReason }
+
+      # @!attribute page_after
+      #   Opaque cursor (`Base.url_encode64` of `{"created_at","id"}`). Cursor mode;
+      #   mutually exclusive with `page[number]` and `page[before]`.
+      #
+      #   @return [String, nil]
+      optional :page_after, String
+
+      # @!attribute page_before
+      #   Opaque cursor (see `page[after]`). Mutually exclusive with `page[after]` and
+      #   `page[number]`.
+      #
+      #   @return [String, nil]
+      optional :page_before, String
+
+      # @!attribute page_number
+      #   Offset page number (≥1, default 1).
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Page size (1–100, default 25).
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute sort
+      #   Sort field. Leading `-` = desc; only `created_at` is sortable. Default
+      #   `-created_at`. `--` is an error.
+      #
+      #   @return [Symbol, Telnyx::Models::EmailBlockListParams::Sort, nil]
+      optional :sort, enum: -> { Telnyx::EmailBlockListParams::Sort }
+
+      # @!method initialize(filter_created_after: nil, filter_created_before: nil, filter_domain_id: nil, filter_reason: nil, page_after: nil, page_before: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailBlockListParams} for more details.
+      #
+      #   @param filter_created_after [Time] `created_at > value` (ISO 8601).
+      #
+      #   @param filter_created_before [Time] `created_at < value` (ISO 8601).
+      #
+      #   @param filter_domain_id [String] Exact-match filter on domain_id (UUID).
+      #
+      #   @param filter_reason [Symbol, Telnyx::Models::EmailBlockListParams::FilterReason] Exact-match filter on reason.
+      #
+      #   @param page_after [String] Opaque cursor (`Base.url_encode64` of `{"created_at","id"}`). Cursor mode; mutua
+      #
+      #   @param page_before [String] Opaque cursor (see `page[after]`). Mutually exclusive with `page[after]` and `pa
+      #
+      #   @param page_number [Integer] Offset page number (≥1, default 1).
+      #
+      #   @param page_size [Integer] Page size (1–100, default 25).
+      #
+      #   @param sort [Symbol, Telnyx::Models::EmailBlockListParams::Sort] Sort field. Leading `-` = desc; only `created_at` is sortable. Default `-created
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # Exact-match filter on reason.
+      module FilterReason
+        extend Telnyx::Internal::Type::Enum
+
+        HARD_BOUNCE = :hard_bounce
+        SPAM_COMPLAINT = :spam_complaint
+        UNSUBSCRIBE = :unsubscribe
+        INVALID = :invalid
+        MANUAL_BLOCK = :manual_block
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Sort field. Leading `-` = desc; only `created_at` is sortable. Default
+      # `-created_at`. `--` is an error.
+      module Sort
+        extend Telnyx::Internal::Type::Enum
+
+        CREATED_AT = :created_at
+        CREATED_AT_DESC = :"-created_at"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_block_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailBlocks#create
+    class EmailBlockResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #   Suppression record. Schema fields hidden by the view: `account_id`,
+      #   `bounce_category`, `dsn_code`, `meta`.
+      #
+      #   @return [Telnyx::Models::EmailBlock]
+      required :data, -> { Telnyx::EmailBlock }
+
+      # @!method initialize(data:)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailBlockResponse} for more details.
+      #
+      #   @param data [Telnyx::Models::EmailBlock] Suppression record. Schema fields hidden by the view:
+    end
+  end
+end

data/lib/telnyx/models/email_block_retrieve_events_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailBlocks#retrieve_events
+    class EmailBlockRetrieveEventsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute page_number
+      #   Offset page number (≥1, default 1).
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Page size (default 50, max 100).
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(id:, page_number: nil, page_size: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param page_number [Integer] Offset page number (≥1, default 1).
+      #
+      #   @param page_size [Integer] Page size (default 50, max 100).
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_block_retrieve_events_response.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailBlocks#retrieve_events
+    class EmailBlockRetrieveEventsResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::EmailBlockRetrieveEventsResponse::Data>]
+      required :data,
+               -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::EmailBlockRetrieveEventsResponse::Data] }
+
+      # @!attribute meta
+      #
+      #   @return [Telnyx::Models::OffsetMeta]
+      required :meta, -> { Telnyx::OffsetMeta }
+
+      # @!method initialize(data:, meta:)
+      #   @param data [Array<Telnyx::Models::EmailBlockRetrieveEventsResponse::Data>]
+      #   @param meta [Telnyx::Models::OffsetMeta]
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute actor
+        #   Free-text (`user_id`/`org_id`/`api_key`/`dev_bypass`/`system`/`manual`).
+        #
+        #   @return [String]
+        required :actor, String
+
+        # @!attribute event_type
+        #
+        #   @return [Symbol, Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::EventType]
+        required :event_type, enum: -> { Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::EventType }
+
+        # @!attribute occurred_at
+        #
+        #   @return [Time]
+        required :occurred_at, Time
+
+        # @!attribute reason
+        #   Free-text snapshot of the block's reason at event time.
+        #
+        #   @return [String]
+        required :reason, String
+
+        # @!attribute record_type
+        #   View-only.
+        #
+        #   @return [Symbol, Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::RecordType]
+        required :record_type, enum: -> { Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::RecordType }
+
+        # @!attribute source
+        #   Free-text snapshot of the block's source at event time.
+        #
+        #   @return [String]
+        required :source, String
+
+        # @!attribute meta
+        #   `null` when the schema field is nil (the context usually sets it to `{}`).
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :meta, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown], nil?: true
+
+        # @!method initialize(id:, actor:, event_type:, occurred_at:, reason:, record_type:, source:, meta: nil)
+        #   @param id [String]
+        #
+        #   @param actor [String] Free-text (`user_id`/`org_id`/`api_key`/`dev_bypass`/`system`/`manual`).
+        #
+        #   @param event_type [Symbol, Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::EventType]
+        #
+        #   @param occurred_at [Time]
+        #
+        #   @param reason [String] Free-text snapshot of the block's reason at event time.
+        #
+        #   @param record_type [Symbol, Telnyx::Models::EmailBlockRetrieveEventsResponse::Data::RecordType] View-only.
+        #
+        #   @param source [String] Free-text snapshot of the block's source at event time.
+        #
+        #   @param meta [Hash{Symbol=>Object}, nil] `null` when the schema field is nil (the context usually sets it to `{}`).
+
+        # @see Telnyx::Models::EmailBlockRetrieveEventsResponse::Data#event_type
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          CREATED = :created
+          REMOVED = :removed
+          EXPIRED = :expired
+          OVERRIDE_USED = :override_used
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # View-only.
+        #
+        # @see Telnyx::Models::EmailBlockRetrieveEventsResponse::Data#record_type
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EMAIL_BLOCK_EVENT = :email_block_event
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_block_retrieve_export_params.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailBlocks#retrieve_export
+    class EmailBlockRetrieveExportParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute filter_created_after
+      #   `created_at > value` (ISO 8601).
+      #
+      #   @return [Time, nil]
+      optional :filter_created_after, Time
+
+      # @!attribute filter_created_before
+      #   `created_at < value` (ISO 8601).
+      #
+      #   @return [Time, nil]
+      optional :filter_created_before, Time
+
+      # @!attribute filter_domain_id
+      #   Exact-match filter on domain_id (UUID).
+      #
+      #   @return [String, nil]
+      optional :filter_domain_id, String
+
+      # @!attribute filter_reason
+      #   Exact-match filter on reason.
+      #
+      #   @return [Symbol, Telnyx::Models::EmailBlockRetrieveExportParams::FilterReason, nil]
+      optional :filter_reason, enum: -> { Telnyx::EmailBlockRetrieveExportParams::FilterReason }
+
+      # @!attribute page_number
+      #   Offset page number (≥1, default 1).
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Page size (1–100, default 25).
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute sort
+      #   Sort field. Leading `-` = desc; only `created_at` is sortable. Default
+      #   `-created_at`. `--` is an error.
+      #
+      #   @return [Symbol, Telnyx::Models::EmailBlockRetrieveExportParams::Sort, nil]
+      optional :sort, enum: -> { Telnyx::EmailBlockRetrieveExportParams::Sort }
+
+      # @!method initialize(filter_created_after: nil, filter_created_before: nil, filter_domain_id: nil, filter_reason: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailBlockRetrieveExportParams} for more details.
+      #
+      #   @param filter_created_after [Time] `created_at > value` (ISO 8601).
+      #
+      #   @param filter_created_before [Time] `created_at < value` (ISO 8601).
+      #
+      #   @param filter_domain_id [String] Exact-match filter on domain_id (UUID).
+      #
+      #   @param filter_reason [Symbol, Telnyx::Models::EmailBlockRetrieveExportParams::FilterReason] Exact-match filter on reason.
+      #
+      #   @param page_number [Integer] Offset page number (≥1, default 1).
+      #
+      #   @param page_size [Integer] Page size (1–100, default 25).
+      #
+      #   @param sort [Symbol, Telnyx::Models::EmailBlockRetrieveExportParams::Sort] Sort field. Leading `-` = desc; only `created_at` is sortable. Default `-created
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # Exact-match filter on reason.
+      module FilterReason
+        extend Telnyx::Internal::Type::Enum
+
+        HARD_BOUNCE = :hard_bounce
+        SPAM_COMPLAINT = :spam_complaint
+        UNSUBSCRIBE = :unsubscribe
+        INVALID = :invalid
+        MANUAL_BLOCK = :manual_block
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Sort field. Leading `-` = desc; only `created_at` is sortable. Default
+      # `-created_at`. `--` is an error.
+      module Sort
+        extend Telnyx::Internal::Type::Enum
+
+        CREATED_AT = :created_at
+        CREATED_AT_DESC = :"-created_at"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_block_retrieve_export_response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    EmailBlockRetrieveExportResponse = String
+  end
+end

data/lib/telnyx/models/email_block_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailBlocks#retrieve
+    class EmailBlockRetrieveParams < 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