telnyx 5.158.0 → 5.159.0

data/lib/telnyx/models/email_template_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailTemplates#list
+    class EmailTemplateListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute page_cursor
+      #   Opaque URL-safe Base64 cursor returned by a previous list response.
+      #
+      #   @return [String, nil]
+      optional :page_cursor, String
+
+      # @!attribute page_size
+      #   Number of results to return. Defaults to 25; maximum is 100. Invalid values are
+      #   clamped to the valid range.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(page_cursor: nil, page_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailTemplateListParams} for more details.
+      #
+      #   @param page_cursor [String] Opaque URL-safe Base64 cursor returned by a previous list response.
+      #
+      #   @param page_size [Integer] Number of results to return. Defaults to 25; maximum is 100. Invalid values are
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_template_list_response.rb

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

data/lib/telnyx/models/email_template_render_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailTemplates#render
+    class EmailTemplateRenderParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute template_variables
+      #   Variables for Liquid template rendering. Non-object values are silently treated
+      #   as an empty object.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :template_variables, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!method initialize(id:, template_variables: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailTemplateRenderParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param template_variables [Hash{Symbol=>Object}] Variables for Liquid template rendering. Non-object values are silently treated
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_template_render_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailTemplates#render
+    class EmailTemplateRenderResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #   Template object with `subject`, `html_body`, and `text_body` replaced by their
+      #   Liquid-rendered values. All other template fields (id, name, variables, etc.)
+      #   remain unchanged.
+      #
+      #   @return [Telnyx::Models::EmailTemplateRenderResponse::Data]
+      required :data, -> { Telnyx::Models::EmailTemplateRenderResponse::Data }
+
+      # @!method initialize(data:)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailTemplateRenderResponse} for more details.
+      #
+      #   @param data [Telnyx::Models::EmailTemplateRenderResponse::Data] Template object with `subject`, `html_body`, and `text_body` replaced by their L
+
+      # @see Telnyx::Models::EmailTemplateRenderResponse#data
+      class Data < Telnyx::Models::EmailTemplate
+        # @!method initialize
+        #   Template object with `subject`, `html_body`, and `text_body` replaced by their
+        #   Liquid-rendered values. All other template fields (id, name, variables, etc.)
+        #   remain unchanged.
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_template_replace_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailTemplates#replace
+    class EmailTemplateReplaceParams < Telnyx::Models::UpdateEmailTemplateRequest
+      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_template_response.rb

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

data/lib/telnyx/models/email_template_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailTemplates#retrieve
+    class EmailTemplateRetrieveParams < 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_template_update_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailTemplates#update
+    class EmailTemplateUpdateParams < Telnyx::Models::UpdateEmailTemplateRequest
+      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_thread_list_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailThreads#list
+    class EmailThreadListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute filter_inbox_id
+      #   Restrict results to one or more inboxes. Repeat the parameter
+      #   (`filter[inbox_id][]=...&filter[inbox_id][]=...`) or pass a comma-separated
+      #   list. Omit to list every inbox in the account. Inboxes outside the account are
+      #   silently excluded. If the filter is present, it must contain at least one
+      #   non-empty UUID.
+      #
+      #   @return [Array<String>, nil]
+      optional :filter_inbox_id, Telnyx::Internal::Type::ArrayOf[String]
+
+      # @!attribute filter_label
+      #   Returns only threads carrying this label. Matching is exact and case-sensitive.
+      #   Thread labels are independent of the labels on the thread's messages.
+      #
+      #   @return [String, nil]
+      optional :filter_label, String
+
+      # @!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(filter_inbox_id: nil, filter_label: nil, page_after: nil, page_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailThreadListParams} for more details.
+      #
+      #   @param filter_inbox_id [Array<String>] Restrict results to one or more inboxes. Repeat the parameter
+      #
+      #   @param filter_label [String] Returns only threads carrying this label. Matching is exact and case-sensitive.
+      #
+      #   @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}]
+    end
+  end
+end

data/lib/telnyx/models/email_thread_retrieve_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailThreads#retrieve
+    class EmailThreadRetrieveParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute thread_id
+      #
+      #   @return [String]
+      required :thread_id, String
+
+      # @!attribute inbox_id
+      #   Inbox UUID that, together with `thread_id`, identifies the thread.
+      #
+      #   @return [String]
+      required :inbox_id, String
+
+      # @!attribute page_after
+      #   Opaque message cursor returned by the previous thread-detail page.
+      #
+      #   @return [String, nil]
+      optional :page_after, String
+
+      # @!attribute page_size
+      #   Number of thread messages to return. Defaults to 25; maximum is 100.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(thread_id:, inbox_id:, page_after: nil, page_size: nil, request_options: {})
+      #   @param thread_id [String]
+      #
+      #   @param inbox_id [String] Inbox UUID that, together with `thread_id`, identifies the thread.
+      #
+      #   @param page_after [String] Opaque message cursor returned by the previous thread-detail page.
+      #
+      #   @param page_size [Integer] Number of thread messages to return. Defaults to 25; maximum is 100.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_thread_retrieve_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailThreads#retrieve
+    class EmailThreadRetrieveResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::EmailInboxes::InboundThreadDetail]
+      required :data, -> { Telnyx::EmailInboxes::InboundThreadDetail }
+
+      # @!attribute meta
+      #
+      #   @return [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
+      required :meta, -> { Telnyx::EmailInboxes::EmailPaginationMeta }
+
+      # @!method initialize(data:, meta:)
+      #   @param data [Telnyx::Models::EmailInboxes::InboundThreadDetail]
+      #   @param meta [Telnyx::Models::EmailInboxes::EmailPaginationMeta]
+    end
+  end
+end

data/lib/telnyx/models/email_unsubscribe_group_create_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailUnsubscribeGroups#create
+    class EmailUnsubscribeGroupCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!method initialize(name:, description: nil, request_options: {})
+      #   @param name [String]
+      #   @param description [String, nil]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_unsubscribe_group_delete_params.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailUnsubscribeGroups#delete
+    class EmailUnsubscribeGroupDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute force
+      #   Force-delete a group with active suppressions. Only `"true"` (string) or `true`
+      #   (bool) are truthy; all other values are false.
+      #
+      #   @return [Symbol, Boolean, Telnyx::Models::EmailUnsubscribeGroupDeleteParams::Force, nil]
+      optional :force, union: -> { Telnyx::EmailUnsubscribeGroupDeleteParams::Force }
+
+      # @!method initialize(id:, force: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailUnsubscribeGroupDeleteParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param force [Symbol, Boolean, Telnyx::Models::EmailUnsubscribeGroupDeleteParams::Force] Force-delete a group with active suppressions. Only `"true"` (string) or `true`
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # Force-delete a group with active suppressions. Only `"true"` (string) or `true`
+      # (bool) are truthy; all other values are false.
+      module Force
+        extend Telnyx::Internal::Type::Union
+
+        variant const: -> { Telnyx::Models::EmailUnsubscribeGroupDeleteParams::Force::TRUE }
+
+        variant const: -> { Telnyx::Models::EmailUnsubscribeGroupDeleteParams::Force::FALSE }
+
+        variant Telnyx::Internal::Type::Boolean
+
+        # @!method self.variants
+        #   @return [Array(Symbol, Boolean)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias { T.any(Telnyx::EmailUnsubscribeGroupDeleteParams::Force::TaggedSymbol, T::Boolean) }
+        end
+
+        # @!group
+
+        TRUE = :true
+        FALSE = :false
+
+        # @!endgroup
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_unsubscribe_group_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailUnsubscribeGroups#list
+    class EmailUnsubscribeGroupListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!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
+
+      # @!method initialize(page_number: nil, page_size: nil, request_options: {})
+      #   @param page_number [Integer] Offset page number (≥1, default 1).
+      #
+      #   @param page_size [Integer] Page size (1–100, default 25).
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_unsubscribe_group_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailUnsubscribeGroups#retrieve
+    class EmailUnsubscribeGroupRetrieveParams < 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_unsubscribe_group_update_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailUnsubscribeGroups#update
+    class EmailUnsubscribeGroupUpdateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(id:, description: nil, name: nil, request_options: {})
+      #   @param id [String]
+      #   @param description [String, nil]
+      #   @param name [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/email_unsubscribe_groups/suppression_create_params.rb

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

data/lib/telnyx/models/email_unsubscribe_groups/suppression_delete_params.rb

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

data/lib/telnyx/models/email_unsubscribe_groups/suppression_list_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module EmailUnsubscribeGroups
+      # @see Telnyx::Resources::EmailUnsubscribeGroups::Suppressions#list
+      class SuppressionListParams < 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 (1–100, default 25).
+        #
+        #   @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 (1–100, default 25).
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/email_validation_check.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class EmailValidationCheck < Telnyx::Internal::Type::BaseModel
+      # @!attribute pass
+      #
+      #   @return [Boolean]
+      required :pass, Telnyx::Internal::Type::Boolean
+
+      # @!attribute details
+      #   Human-readable check detail. Omitted when nil.
+      #
+      #   @return [String, nil]
+      optional :details, String
+
+      # @!method initialize(pass:, details: nil)
+      #   @param pass [Boolean]
+      #
+      #   @param details [String] Human-readable check detail. Omitted when nil.
+    end
+  end
+end

data/lib/telnyx/models/email_validation_create_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::EmailValidations#create
+    class EmailValidationCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute email
+      #   Email address to validate. Any non-empty string is accepted; invalid syntax
+      #   returns valid=false rather than a request error.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(email:, idempotency_key: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::EmailValidationCreateParams} for more details.
+      #
+      #   @param email [String] Email address to validate. Any non-empty string is accepted; invalid syntax retu
+      #
+      #   @param idempotency_key [String]
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end