SunshineConversationsClient::Author

August 27, 2025 · View on GitHub

Properties

Name	Type	Description	Notes
type	String	The author type. Either "user" (representing the end user) or "business" (sent on behalf of the business).
subtypes	Array<String>	A string array that indicates the author's subtypes. Messages from "business" type with an "AI" subtype are generated by AI and a disclaimer is appended to the text of the message sent to the customer. For third-party channels, the disclaimer is applied for image, file, and text message types. Message with an "activity" subtype are generated by system activities.	[optional]
user_id	String	The id of the user. Only supported when `type` is user.	[optional]
user_external_id	String	The externalId of the user. Only supported when `type` is user.	[optional]
display_name	String	The display name of the message author.	[optional]
avatar_url	String	A custom message icon URL. The image must be JPG, PNG, or GIF format.	[optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::Author.new(
  type: business,
  subtypes: null,
  user_id: 5963c0d619a30a2e00de36b8,
  user_external_id: your-own-id,
  display_name: Steve,
  avatar_url: https://www.gravatar.com/image.jpg
)