Class: Telnyx::Models::EmailInboxes::EmailMessage::Attachment

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/email_inboxes/email_message.rb,
sig/telnyx/models/email_inboxes/email_message.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, attachments:, bcc:, cc:, created_at:, events:, from:, record_type:, reply_to:, status:, subject:, template_id:, template_variables:, to:, inline_css: nil, recipient_statuses: nil, sandbox: nil, scheduled_at: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::EmailInboxes::EmailMessage for more details.

Parameters:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 149

class Attachment < Telnyx::Internal::Type::BaseModel
  # @!attribute content_id
  #   MIME Content-ID for inline references.
  #
  #   @return [String, nil]
  required :content_id, String, nil?: true

  # @!attribute content_type
  #
  #   @return [String]
  required :content_type, String

  # @!attribute disposition
  #   MIME disposition (e.g. `attachment` or `inline`). Runtime passes through the
  #   stored value without enforcing an enum.
  #
  #   @return [String]
  required :disposition, String

  # @!attribute filename
  #
  #   @return [String]
  required :filename, String

  # @!attribute sha256
  #   SHA-256 hex digest of the attachment content.
  #
  #   @return [String, nil]
  required :sha256, String, nil?: true

  # @!attribute size_bytes
  #   Attachment size in bytes.
  #
  #   @return [Integer, nil]
  required :size_bytes, Integer, nil?: true

  # @!attribute url
  #   Telnyx-hosted public URL for the attachment content.
  #
  #   @return [String, nil]
  required :url, String, nil?: true

  # @!method initialize(content_id:, content_type:, disposition:, filename:, sha256:, size_bytes:, url:)
  #   Some parameter documentations has been truncated, see
  #   {Telnyx::Models::EmailInboxes::EmailMessage::Attachment} for more details.
  #
  #   EDR-aligned attachment metadata. The base64 `content` is never returned.
  #
  #   @param content_id [String, nil] MIME Content-ID for inline references.
  #
  #   @param content_type [String]
  #
  #   @param disposition [String] MIME disposition (e.g. `attachment` or `inline`). Runtime passes through the sto
  #
  #   @param filename [String]
  #
  #   @param sha256 [String, nil] SHA-256 hex digest of the attachment content.
  #
  #   @param size_bytes [Integer, nil] Attachment size in bytes.
  #
  #   @param url [String, nil] Telnyx-hosted public URL for the attachment content.
end

Instance Attribute Details

#content_id ⇒ String?

MIME Content-ID for inline references.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


154
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 154

required :content_id, String, nil?: true

#content_type ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


159
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 159

required :content_type, String

#disposition ⇒ String

MIME disposition (e.g. attachment or inline). Runtime passes through the stored value without enforcing an enum.

Parameters:

  • value (String)

Returns:

  • (String) 


166
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 166

required :disposition, String

#filename ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


171
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 171

required :filename, String

#sha256 ⇒ String?

SHA-256 hex digest of the attachment content.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


177
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 177

required :sha256, String, nil?: true

#size_bytes ⇒ Integer?

Attachment size in bytes.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


183
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 183

required :size_bytes, Integer, nil?: true

#url ⇒ String?

Telnyx-hosted public URL for the attachment content.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


189
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 189

required :url, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


151
 
# File 'sig/telnyx/models/email_inboxes/email_message.rbs', line 151

def to_hash: -> {