SunshineConversationsClient::Item

August 27, 2025 ยท View on GitHub

Properties

NameTypeDescriptionNotes
titleStringThe title of the item.
descriptionStringThe description of the item.[optional]
media_urlStringThe image url attached to the item.[optional]
media_typeStringThe MIME type for any image attached in the mediaUrl.[optional]
alt_textStringAn optional description of the media for accessibility purposes. The field will be saved by default with the file name as the value.[optional]
sizeStringThe size of the image.[optional]
actionsArray<ActionSubset>An array of objects representing the actions associated with the item.
metadataHash<String, Object>Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.[optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::Item.new(
  title: null,
  description: null,
  media_url: null,
  media_type: null,
  alt_text: null,
  size: null,
  actions: null,
  metadata: {&quot;lang&quot;:&quot;en-ca&quot;}
)