SunshineConversationsClient::ClientRemoveEventAllOfPayload
August 27, 2025 ยท View on GitHub
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| conversation | ConversationTruncated | The conversation associated with the removal of the client. This field is only present when the reason is `theft`, `linkCancelled` or `linkFailed`. Note that for the `theft` reason, the conversation will not be present if it has been deleted. | [optional] |
| user | UserTruncated | The user associated with the client. | [optional] |
| client | Client | The removed client. | [optional] |
| reason | String | The reason for which the client was removed. * `api` - The client was removed using the API. * `linkCancelled` - The user cancelled a channel link. * `linkFailed` - The client was removed after a channel link attempt failed. * `sdk` - The client was removed using the SDK. * `theft` - The client was transferred to another user due to a channel link. | [optional] |
| error | Object | Object containing details of what went wrong. This field will only be present when the reason is `linkCancelled` or `linkFailed`. | [optional] |
| source | SourceWebhook | The source where this event originated from. This could be the API or an SDK device. | [optional] |
Example
require 'sunshine-conversations-client'
instance = SunshineConversationsClient::ClientRemoveEventAllOfPayload.new(
conversation: null,
user: null,
client: null,
reason: null,
error: null,
source: null
)