Package com.zendesk.sunshine_conversations_client.model

Interface Summary

Interface	Description
Action
ActionSubset
ActivityMessage
Content
Destination
IntegrationUpdate
MatchCriteria
ParticipantLeaveBody
QuotedMessage

Class Summary

Class	Description
AcceptControlBody	AcceptControlBody
Activity	Activity
ActivityAllOf	ActivityAllOf
ActivityPost	ActivityPost
ActivityPostAllOf	ActivityPostAllOf
ActivityTypes	ActivityTypes
Android	Android
AndroidAllOf	AndroidAllOf
AndroidUpdate	AndroidUpdate
AndroidUpdateAllOf	AndroidUpdateAllOf
ApiKey	The integration key.
App	App
AppCreateBody	AppCreateBody
AppKey	AppKey
AppKeyCreateBody	AppKeyCreateBody
AppKeyListResponse	AppKeyListResponse
AppKeyResponse	AppKeyResponse
Apple	Apple
AppleAllOf	AppleAllOf
AppleMessageOverridePayload	The exact payload to send to the channel.
AppleUpdate	AppleUpdate
AppleUpdateAllOf	AppleUpdateAllOf
AppListFilter	AppListFilter
AppListResponse	AppListResponse
AppResponse	AppResponse
AppSettings	Customizable app settings.
AppSubSchema	The app that triggered the events.
AppUpdateBody	AppUpdateBody
AttachmentDeleteBody	AttachmentDeleteBody
AttachmentResponse	AttachmentResponse
AttachmentSchema	AttachmentSchema
AttachmentUploadBody	AttachmentUploadBody
Author	The author of the message.
AuthorWebhook	The author of the activity.
Buy	Buy
Campaign	The campaign the user interacted with (if applicable).
CarouselMessage	Carousel messages are a horizontally scrollable set of items that may each contain text, an image, and message actions.
CarouselMessageDisplaySettings	Settings to adjust the carousel layout.
Client	Client
ClientAddEvent	ClientAddEvent
ClientAddEventAllOf	ClientAddEventAllOf
ClientAddEventAllOfPayload	The payload of the event.
ClientAssociation	ClientAssociation
ClientCreate	ClientCreate
ClientListResponse	ClientListResponse
ClientRemoveEvent	ClientRemoveEvent
ClientRemoveEventAllOf	ClientRemoveEventAllOf
ClientRemoveEventAllOfPayload	The payload of the event.
ClientResponse	ClientResponse
ClientUpdateEvent	ClientUpdateEvent
ClientUpdateEventAllOf	ClientUpdateEventAllOf
ClientUpdateEventAllOfPayload	The payload of the event.
Confirmation	The confirmation options of the link request.
Conversation	Conversation
ConversationAllOf	ConversationAllOf
ConversationCreateBody	ConversationCreateBody
ConversationCreateEvent	ConversationCreateEvent
ConversationCreateEventAllOf	ConversationCreateEventAllOf
ConversationCreateEventAllOfPayload	The payload of the event.
ConversationJoinEvent	ConversationJoinEvent
ConversationJoinEventAllOf	ConversationJoinEventAllOf
ConversationJoinEventAllOfPayload	The payload of the event.
ConversationLeaveEvent	ConversationLeaveEvent
ConversationLeaveEventAllOf	ConversationLeaveEventAllOf
ConversationLeaveEventAllOfPayload	The payload of the event.
ConversationListFilter	ConversationListFilter
ConversationListResponse	ConversationListResponse
ConversationMessageDeliveryChannelEvent	ConversationMessageDeliveryChannelEvent
ConversationMessageDeliveryChannelEventAllOf	ConversationMessageDeliveryChannelEventAllOf
ConversationMessageDeliveryFailureEvent	ConversationMessageDeliveryFailureEvent
ConversationMessageDeliveryFailureEventAllOf	ConversationMessageDeliveryFailureEventAllOf
ConversationMessageDeliveryPayload	The payload of the event.
ConversationMessageDeliveryPayloadDestination	A nested object representing the destination of the message.
ConversationMessageDeliveryPayloadExternalMessages	ConversationMessageDeliveryPayloadExternalMessages
ConversationMessageDeliveryPayloadMessage	The message that was sent.
ConversationMessageDeliveryUserEvent	ConversationMessageDeliveryUserEvent
ConversationMessageEvent	ConversationMessageEvent
ConversationMessageEventAllOf	ConversationMessageEventAllOf
ConversationMessageEventAllOfPayload	The payload of the event.
ConversationPostbackEvent	ConversationPostbackEvent
ConversationPostbackEventAllOf	ConversationPostbackEventAllOf
ConversationPostbackEventAllOfPayload	The payload of the event.
ConversationReadEvent	ConversationReadEvent
ConversationReadEventAllOf	ConversationReadEventAllOf
ConversationReadEventAllOfPayload	The payload of the event.
ConversationReferralEvent	ConversationReferralEvent
ConversationReferralEventAllOf	ConversationReferralEventAllOf
ConversationReferralEventAllOfPayload	The payload of the event.
ConversationRemoveEvent	ConversationRemoveEvent
ConversationRemoveEventAllOf	ConversationRemoveEventAllOf
ConversationRemoveEventAllOfPayload	The payload of the event.
ConversationResponse	ConversationResponse
ConversationTruncated	ConversationTruncated
ConversationTypingEvent	ConversationTypingEvent
ConversationTypingEventAllOf	ConversationTypingEventAllOf
ConversationTypingEventAllOfPayload	The payload of the event.
ConversationUpdateBody	ConversationUpdateBody
Custom	Custom
CustomAllOf	CustomAllOf
CustomUpdate	CustomUpdate
DefaultResponder	DefaultResponder
DefaultResponderDefaultResponder	The default responder object.
DefaultResponderId	DefaultResponderId
Device	Device
DeviceListResponse	DeviceListResponse
DeviceResponse	DeviceResponse
DownloadMessageRefBody	DownloadMessageRefBody
DownloadMessageRefBodyAllOf	DownloadMessageRefBodyAllOf
DownloadMessageRefBodyAllOfApple	The message ref returned by Apple.
DownloadMessageRefBodyAllOfAppleInteractiveDataRef	interactiveDataRef can be found in the passthrough webhook.
EventSubSchema	EventSubSchema
ExtraChannelOptions	Extra options to pass directly to the channel API.
ExtraChannelOptionsMessenger	Messenger channel options.
Field	Field
FileMessage	FileMessage
FormMessage	A form type message without text or actions.
FormMessageField	FormMessageField
FormMessageFieldAllOf	Properties that can be expected to receive inside a form message field.
FormResponseMessage	A formResponse type message is a response to a form type message.
FormResponseMessageField	FormResponseMessageField
FormResponseMessageFieldAllOf	Properties that can be expected to receive inside a form response message field.
Identity	A connected user identity, such as an email.
ImageMessage	ImageMessage
InlineObject	InlineObject
Instagram	Instagram
InstagramAllOf	InstagramAllOf
InstagramUpdate	InstagramUpdate
InstagramUpdateAllOf	InstagramUpdateAllOf
Integration	The integration.
IntegrationApiKey	IntegrationApiKey
IntegrationApiKeyListResponse	IntegrationApiKeyListResponse
IntegrationApiKeyResponse	IntegrationApiKeyResponse
IntegrationId	IntegrationId
IntegrationListFilter	IntegrationListFilter
IntegrationListResponse	IntegrationListResponse
IntegrationResponse	IntegrationResponse
IntegrationType	IntegrationType
IntegrationUpdateBase	IntegrationUpdateBase
Ios	Ios
IosAllOf	IosAllOf
IosUpdate	IosUpdate
IosUpdateAllOf	IosUpdateAllOf
Item	Item
Line	Line
LineAllOf	LineAllOf
LineUpdate	LineUpdate
Link	A link action will open the provided URI when tapped.
Links	Previous and next page links, if they exist.
ListMessage	List messages are a vertically scrollable set of items that may each contain text, an image, and message actions.
LocationMessage	A location type message includes the coordinates (latitude and longitude) of a location and an optional location object which can include the name and address of the location.
LocationMessageCoordinates	The coordinates of the location.
LocationMessageLocation	Information about the location.
LocationRequest	A location request action will prompt the user to share their location.
Mailgun	Mailgun
MailgunAllOf	MailgunAllOf
MailgunUpdate	MailgunUpdate
MailgunUpdateAllOf	MailgunUpdateAllOf
MatchCriteriaBase	The set of criteria used to determine the user's identity on a third-party channel.
MatchCriteriaMailgun	MatchCriteriaMailgun
MatchCriteriaMailgunAllOf	The set of criteria used to determine the user's identity on a third-party channel.
MatchCriteriaMessagebird	MatchCriteriaMessagebird
MatchCriteriaMessagebirdAllOf	The set of criteria used to determine the user's identity on a third-party channel.
MatchCriteriaTwilio	MatchCriteriaTwilio
MatchCriteriaTwilioAllOf	The set of criteria used to determine the user's identity on a third-party channel.
MatchCriteriaWhatsapp	MatchCriteriaWhatsapp
MatchCriteriaWhatsappAllOf	The set of criteria used to determine the user's identity on a third-party channel.
Message	Message
Messagebird	Messagebird
MessagebirdAllOf	MessagebirdAllOf
MessageBirdUpdate	MessageBirdUpdate
MessageListResponse	MessageListResponse
MessageOverride	A raw payload containing a message that is sent directly to a channel.
MessageOverrideApple	MessageOverrideApple
MessageOverrideLine	MessageOverrideLine
MessageOverrideMessenger	MessageOverrideMessenger
MessageOverridePayload	The exact payload to send to the channel.
MessageOverrideWhatsapp	MessageOverrideWhatsapp
MessagePost	MessagePost
MessagePostResponse	The created messages.
MessageWebhook	MessageWebhook
Messenger	Messenger
MessengerAllOf	MessengerAllOf
MessengerUpdate	MessengerUpdate
Meta	Response metadata.
OfferControlBody	OfferControlBody
Page	Page
Participant	Participant
ParticipantJoinBody	ParticipantJoinBody
ParticipantLeaveBodyParticipantId	ParticipantLeaveBodyParticipantId
ParticipantLeaveBodyUserExternalId	ParticipantLeaveBodyUserExternalId
ParticipantLeaveBodyUserId	ParticipantLeaveBodyUserId
ParticipantListResponse	List of returned participants.
ParticipantResponse	The created participant.
ParticipantSubSchema	ParticipantSubSchema
ParticipantWithUserExternalId	ParticipantWithUserExternalId
ParticipantWithUserId	ParticipantWithUserId
PassControlBody	PassControlBody
Postback	Postback
PostbackWebhook	PostbackWebhook
PrechatCapture	PrechatCapture
Profile	Object hosting user profile information.
QuotedMessageExternalMessageId	QuotedMessageExternalMessageId
QuotedMessageMessage	QuotedMessageMessage
Referral	Data representing a referral object when a user is referred to a conversation.
ReferralDetails	Nested object containing additional information.
Reply	Reply
Source	The source of the message.
SourceWebhook	SourceWebhook
SourceWithCampaignWebhook	SourceWithCampaignWebhook
SourceWithCampaignWebhookAllOf	SourceWithCampaignWebhookAllOf
Switchboard	Switchboard
SwitchboardAcceptControl	SwitchboardAcceptControl
SwitchboardAcceptControlAllOf	SwitchboardAcceptControlAllOf
SwitchboardAcceptControlAllOfPayload	The payload of the event.
SwitchboardAcceptControlFailure	SwitchboardAcceptControlFailure
SwitchboardAcceptControlFailureAllOf	SwitchboardAcceptControlFailureAllOf
SwitchboardAcceptControlFailureAllOfPayload	The payload of the event.
SwitchboardIntegration	SwitchboardIntegration
SwitchboardIntegrationCreateBody	SwitchboardIntegrationCreateBody
SwitchboardIntegrationListResponse	SwitchboardIntegrationListResponse
SwitchboardIntegrationResponse	SwitchboardIntegrationResponse
SwitchboardIntegrationUpdateBody	SwitchboardIntegrationUpdateBody
SwitchboardIntegrationWebhook	SwitchboardIntegrationWebhook
SwitchboardListResponse	SwitchboardListResponse
SwitchboardOfferControl	SwitchboardOfferControl
SwitchboardOfferControlAllOf	SwitchboardOfferControlAllOf
SwitchboardOfferControlAllOfPayload	The payload of the event.
SwitchboardOfferControlFailure	SwitchboardOfferControlFailure
SwitchboardPassControl	SwitchboardPassControl
SwitchboardPassControlAllOf	SwitchboardPassControlAllOf
SwitchboardPassControlAllOfPayload	The payload of the event.
SwitchboardPassControlFailure	SwitchboardPassControlFailure
SwitchboardResponse	SwitchboardResponse
SwitchboardUpdateBody	SwitchboardUpdateBody
Target	The target conversation to attach the client to.
Telegram	Telegram
TelegramAllOf	TelegramAllOf
TelegramUpdate	TelegramUpdate
TemplateMessage	TemplateMessage
TextMessage	TextMessage
TicketClosed	TicketClosed
TransferToEmail	TransferToEmail
Twilio	Twilio
TwilioAllOf	TwilioAllOf
TwilioUpdate	TwilioUpdate
Twitter	Twitter
TwitterAllOf	TwitterAllOf
TwitterUpdate	TwitterUpdate
Unity	Unity
UnityAllOf	UnityAllOf
UnityUpdate	UnityUpdate
UnityUpdateAllOf	UnityUpdateAllOf
User	User
UserAllOf	UserAllOf
UserCreateBody	UserCreateBody
UserMergeEvent	UserMergeEvent
UserMergeEventAllOf	UserMergeEventAllOf
UserMergeEventAllOfPayload	The payload of the event.
UserMergeEventAllOfPayloadMergedClients	Contains information about the clients that were merged together as a result of the operation, if applicable.
UserMergeEventAllOfPayloadMergedConversations	Contains information about the conversations that were merged together as a result of the operation, if applicable.
UserMergeEventAllOfPayloadMergedUsers	Contains information about the users that were merged together.
UserRemoveEvent	UserRemoveEvent
UserRemoveEventAllOf	UserRemoveEventAllOf
UserRemoveEventAllOfPayload	The payload of the event.
UserResponse	UserResponse
UserTruncated	UserTruncated
UserUpdateBody	UserUpdateBody
UserUpdateEvent	UserUpdateEvent
UserUpdateEventAllOf	UserUpdateEventAllOf
UserUpdateEventAllOfPayload	The payload of the event.
Viber	Viber
ViberAllOf	ViberAllOf
ViberUpdate	ViberUpdate
Web	Web
WebAllOf	WebAllOf
Webhook	Webhook
WebhookBody	WebhookBody
WebhookCreateBody	WebhookCreateBody
WebhookListResponse	WebhookListResponse
WebhookResponse	WebhookResponse
WebhookSubSchema	The webhook that generated the payload.
WebUpdate	WebUpdate
WebUpdateAllOf	To configure a Web Messenger integration, acquire the required information and call the Create Integration endpoint.
Webview	When a webview actions is clicked/tapped, the provided URI will be loaded in a webview.
Whatsapp	Whatsapp
WhatsappAllOf	WhatsappAllOf
WhatsAppUpdate	WhatsAppUpdate
WhatsAppUpdateAllOf	WhatsAppUpdateAllOf

Enum Summary

Enum	Description
Activity.TypeEnum	If the author type is `user`, only `conversation:read` is supported.
ActivityPost.TypeEnum	If the author type is `user`, only `conversation:read` is supported.
ActivityTypes.TypeEnum	If the author type is `user`, only `conversation:read` is supported.
AppleMessageOverridePayload.WithCapabilitiesEnum	Gets or Sets withCapabilities
Author.SubtypesEnum	Gets or Sets subtypes
Author.TypeEnum	The author type.
AuthorWebhook.TypeEnum	The `type` of the author.
CarouselMessageDisplaySettings.ImageAspectRatioEnum	Specifies how to display all carousel images.
Client.StatusEnum	The client status.
ClientAddEventAllOfPayload.ReasonEnum	The reason for which the client was added.
ClientRemoveEventAllOfPayload.ReasonEnum	The reason for which the client was removed.
ClientType	The type of integration that the client represents.
ClientUpdateEventAllOfPayload.ReasonEnum	The reason for which the client was updated.
Confirmation.TypeEnum	The type of confirmation.
ConversationCreateEventAllOfPayload.CreationReasonEnum	The reason why the conversation was created, if applicable.
ConversationType	The type of the conversation.
Device.StatusEnum	The device status.
Device.TypeEnum	The type of integration that the device represents.
ExtraChannelOptionsMessenger.WebviewShareButtonEnum	For webview type actions, a string value indicating if the share button should be hidden.
Field.TypeEnum	The field type.
FormMessageField.TypeEnum	The field type.
FormResponseMessageField.TypeEnum	The field type.
Item.SizeEnum	The size of the image.
Status	The status of the integration.
Twitter.TierEnum	Your Twitter app's tier.
TwitterAllOf.TierEnum	Your Twitter app's tier.
UserMergeEventAllOfPayload.ReasonEnum	The reason for which the users merged.
UserUpdateEventAllOfPayload.ReasonEnum	The reason why the user was updated, if applicable.
Webview.SizeEnum	The size to display a webview.