Package app.knock.api.models.messages
See: Description
-
Class Summary Class Description Builder A builder for Activity. Builder A builder for Data. Data The workflow trigger datapayload associated with the activity.Activity An activity associated with a workflow trigger request. Builder A builder for Message. Builder A builder for Data. Data Data associated with the message’s workflow run. EngagementStatus An engagement status for a message. Builder A builder for Metadata. Metadata The metadata associated with the message. Builder A builder for Source. Source The workflow that triggered the message. Status The message delivery status. Message Represents a single message that was generated by a workflow for a given channel. Builder A builder for MessageArchiveParams. MessageArchiveParams Archives a message for the user. Builder A builder for MessageDeliveryLog. Builder A builder for Request. Builder A builder for UnionMember1. UnionMember1 Body The body content that was sent with the request. Builder A builder for Headers. Headers The headers that were sent with the request. Method The HTTP method used for the request. Request A message delivery log request. Builder A builder for Response. Builder A builder for UnionMember1. UnionMember1 Body The body content that was received with the response. Builder A builder for Headers. Headers The headers that were received with the response. Response A message delivery log response. MessageDeliveryLog A message delivery log contains a requestfrom Knock to a downstream provider and theresponsethat was returned.Builder A builder for MessageEvent. Type The type of event that occurred. Builder A builder for Data. Data The data associated with the message event. MessageEvent A message event. Builder A builder for MessageGetContentParams. MessageGetContentParams Returns the fully rendered contents of a message, where the response depends on which channel the message was sent through. Builder A builder for MessageGetContentResponse. Builder A builder for MessageEmailContent. MessageEmailContent The content of an email message. Builder A builder for MessageSmsContent. MessageSmsContent The content of an SMS message. Builder A builder for MessagePushContent. Builder A builder for InnerData. InnerData Additional data payload for the push notification. MessagePushContent The content of a push notification. Builder A builder for MessageChatContent. Builder A builder for Connection. Connection The channel data connection from the recipient to the underlying provider. Builder A builder for Template. Builder A builder for Block. Type The type of block in a message in a chat (text or markdown). Block A block in a message in a chat. Builder A builder for JsonContent. JsonContent The JSON content of the message. Template The template structure for the chat message. Builder A builder for Metadata. Metadata Additional metadata associated with the chat message. MessageChatContent The content of a chat message. Builder A builder for MessageInAppFeedContent. Builder A builder for MessageInAppFeedContentBlock. Type The type of block in a message in an app feed. MessageInAppFeedContentBlock A block in a message in an app feed. Builder A builder for MessageInAppFeedButtonSetBlock. Builder A builder for Button. Button A button in an in app feed message. Type The type of block in a message in an app feed. MessageInAppFeedButtonSetBlock A button set block in a message in an app feed. Block A block in a message in an app feed. MessageInAppFeedContent The content of an in-app feed message. Data Content data specific to the channel type. MessageGetContentResponse The content of a message. Builder A builder for MessageGetParams. MessageGetParams Retrieves a specific message by its ID. Builder A builder for MessageListActivitiesPage. AutoPager MessageListActivitiesPage Builder A builder for MessageListActivitiesPageAsync. AutoPager MessageListActivitiesPageAsync Builder A builder for MessageListActivitiesPageResponse. MessageListActivitiesPageResponse Returns a paginated list of activitiesassociated with a given message.Builder A builder for MessageListActivitiesParams. MessageListActivitiesParams Returns a paginated list of activities for the specified message. Builder A builder for MessageListDeliveryLogsPage. AutoPager MessageListDeliveryLogsPage Builder A builder for MessageListDeliveryLogsPageAsync. AutoPager MessageListDeliveryLogsPageAsync Builder A builder for MessageListDeliveryLogsPageResponse. MessageListDeliveryLogsPageResponse A message delivery log response. Builder A builder for MessageListDeliveryLogsParams. MessageListDeliveryLogsParams Returns a paginated list of delivery logs for the specified message. Builder A builder for MessageListEventsPage. AutoPager MessageListEventsPage Builder A builder for MessageListEventsPageAsync. AutoPager MessageListEventsPageAsync Builder A builder for MessageListEventsPageResponse. MessageListEventsPageResponse Returns a paginated list of /send-notifications/message-statuses events for the specified message. Builder A builder for MessageListEventsParams. MessageListEventsParams Returns a paginated list of events for the specified message. Builder A builder for MessageListPage. AutoPager MessageListPage Builder A builder for MessageListPageAsync. AutoPager MessageListPageAsync Builder A builder for MessageListPageResponse. MessageListPageResponse A paginated list of messages. Builder A builder for MessageListParams. EngagementStatus Builder A builder for InsertedAt. InsertedAt Status MessageListParams Returns a paginated list of messages for the current environment. Builder A builder for MessageMarkAsInteractedParams. Builder A builder for Body. Body A request to mark a message as interacted with. Builder A builder for Metadata. Metadata Metadata about the interaction. MessageMarkAsInteractedParams Marks a message as interactedwith by the user.Builder A builder for MessageMarkAsReadParams. MessageMarkAsReadParams Marks a message as read.Builder A builder for MessageMarkAsSeenParams. MessageMarkAsSeenParams Marks a message as seen.Builder A builder for MessageMarkAsUnreadParams. MessageMarkAsUnreadParams Marks a message as unread.Builder A builder for MessageMarkAsUnseenParams. MessageMarkAsUnseenParams Marks a message as unseen.Builder A builder for MessageUnarchiveParams. MessageUnarchiveParams Removes a message from the archived state, making it visible in the default message list in the feed again. -
Enum Summary Enum Description Known An enum containing EngagementStatus's known values. Value An enum containing EngagementStatus's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Method's known values. Value An enum containing Method's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing EngagementStatus's known values. Value An enum containing EngagementStatus's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. -
Interface Summary Interface Description Visitor An interface that defines how to map each variant of Body to a value of type T. Visitor An interface that defines how to map each variant of Body to a value of type T. Visitor An interface that defines how to map each variant of Data to a value of type T. Visitor An interface that defines how to map each variant of Block to a value of type T.