front_api

Module types

Source
Expand description

This module contains the generated types for the library.

Modules§

base64
Base64 data that encodes to url safe base64, but can decode from multiple base64 implementations to account for various clients and libraries. Compatible with serde and JsonSchema.
error
Error methods.
paginate
Utility functions used for pagination.
phone_number
A library to implement phone numbers for our database and JSON serialization and deserialization.

Structs§

AcceptedApplicationJson
AcceptedCannedAnswerFolderDeletionApplicationJson
AcceptedMessageApplicationJson
Account
AccountIds
AccountResponse
AddContactsToGroup
AddConversationFollowersRequestBody
AddConversationLinkRequestBody
AnalyticsExportRequest2
AnalyticsExportResponse2
AnalyticsExportResponse2UnderscoreLinks
AnalyticsFilters
Resources to compute the analytics for. Defaults to all.
AnalyticsReportRequest2
AnalyticsReportResponse2
AnalyticsReportResponse2UnderscoreLinks
AnalyticsScalar2
AnalyticsScalarValue
Attachment
AttachmentMetadata
Attachment metadata
ChannelIds
ChannelResponse
ChannelResponseSettings
Channel settings
ChannelResponseUnderscoreLinks
ChannelResponseUnderscoreLinksRelated
Comment
Details for the starter comment
CommentResponse
CommentResponseUnderscoreLinks
CommentResponseUnderscoreLinksRelated
Contact
ContactGroupResponses
ContactGroupResponsesUnderscoreLinks
ContactGroupResponsesUnderscoreLinksRelated
ContactHandle
ContactIds
ContactNoteResponses
ContactResponse
ContactResponseUnderscoreLinks
ContactResponseUnderscoreLinksRelated
ConversationResponse
ConversationResponseMetadata
Optional metadata about the conversation
ConversationResponseUnderscoreLinks
ConversationResponseUnderscoreLinksRelated
CreateChannel
CreateChannelSettings
Settings of the channel
CreateComment
CreateContact
CreateContactGroup
CreateContactNote
CreateConversation
CreateDraft
CreateInbox
CreateLink
A link is used to connect a Front conversation to an external resource.
CreateMessageTemplateAsChild
A message template that is used for pre-written responses
CreateMessageTemplateFolder
A message template folder that is used to store message templates or other folders.
CreateMessageTemplateFolderAsChild
A message template folder that is used to store message templates or other folders.
CreatePrivateMessageTemplate
A message template that is used for pre-written responses
CreatePrivateSignature
A signature that can be used to sign messages.
CreateSharedMessageTemplate
A message template that is used for pre-written responses
CreateSharedSignature
A signature that can be used to sign messages.
CreateShift
CreateTag
A tag is a label that can be used to classify conversations.
CustomFieldResponse
CustomFieldResponseUnderscoreLinks
CustomMessage
DeleteContactHandle
DeleteConversationFollowersRequestBody
DeleteDraft
DeleteFolderResponse
EditDraft
EventResponse
An event is created everytime something interesting is happening in Front.
EventResponseSource
Event source
EventResponseUnderscoreLinks
GetChildFoldersResponse
GetChildFoldersResponseUnderscoreLinks
GetChildTemplatesResponse
GetChildTemplatesResponseUnderscoreLinks
GetMessageSeenStatusResponse
GetMessageSeenStatusResponseUnderscoreLinks
IdentityResponse
IdentityResponseUnderscoreLinks
ImportInboxMessageResponse
ImportMessage
ImportMessageMetadata
ImportMessageSender
Data of the sender
InboxIds
InboxResponse
InboxResponseUnderscoreLinks
InboxResponseUnderscoreLinksRelated
LinkResponse
A link used to connect a Front conversation to an external resource.
LinkResponseUnderscoreLinks
ListAccountContactsResponse
ListAccountContactsResponseUnderscoreLinks
ListAccountsResponse
ListAccountsResponseUnderscoreLinks
ListAssignedConversationsResponse
ListAssignedConversationsResponseUnderscoreLinks
ListChannelsResponse
ListChannelsResponseUnderscoreLinks
ListCommentMentionsResponse
ListCommentMentionsResponseUnderscoreLinks
ListContactConversationsResponse
ListContactConversationsResponseUnderscoreLinks
ListContactCustomFieldsResponse
ListContactCustomFieldsResponseUnderscoreLinks
ListContactsResponse
ListContactsResponseUnderscoreLinks
ListConversationCommentsResponse
ListConversationCommentsResponseUnderscoreLinks
ListConversationDraftsResponse
ListConversationDraftsResponseUnderscoreLinks
ListConversationEventsResponse
ListConversationEventsResponseUnderscoreLinks
ListConversationFollowersResponse
ListConversationFollowersResponseUnderscoreLinks
ListConversationInboxesResponse
ListConversationInboxesResponseUnderscoreLinks
ListConversationMessagesResponse
ListConversationMessagesResponseUnderscoreLinks
ListConversationsResponse
ListConversationsResponseUnderscoreLinks
ListCustomFieldsResponse
ListCustomFieldsResponseUnderscoreLinks
ListEventsResponse
ListEventsResponseUnderscoreLinks
ListFoldersResponse
ListFoldersResponseUnderscoreLinks
ListGroupContactsResponse
ListGroupContactsResponseUnderscoreLinks
ListGroupsResponse
ListGroupsResponseUnderscoreLinks
ListInboxChannelsResponse
ListInboxChannelsResponseUnderscoreLinks
ListInboxConversationsResponse
ListInboxConversationsResponseUnderscoreLinks
ListInboxTeammatesResponse
ListInboxTeammatesResponseUnderscoreLinks
ListInboxesResponse
ListInboxesResponseUnderscoreLinks
ListLinkConversationsResponse
ListLinkConversationsResponseUnderscoreLinks
ListLinksResponse
ListLinksResponseUnderscoreLinks
ListMessageTemplatesResponse
ListMessageTemplatesResponseUnderscoreLinks
ListNotesResponse
ListNotesResponseUnderscoreLinks
ListOfAccountsApplicationJson
ListOfAccountsApplicationJsonUnderscoreLinks
ListOfCannedAnswerFoldersApplicationJson
ListOfCannedAnswerFoldersApplicationJsonUnderscoreLinks
ListOfCannedAnswersApplicationJson
ListOfCannedAnswersApplicationJsonUnderscoreLinks
ListOfChannelsApplicationJson
ListOfChannelsApplicationJsonUnderscoreLinks
ListOfCommentsApplicationJson
ListOfCommentsApplicationJsonUnderscoreLinks
ListOfContactGroupsApplicationJson
ListOfContactGroupsApplicationJsonUnderscoreLinks
ListOfContactNotesApplicationJson
ListOfContactNotesApplicationJsonUnderscoreLinks
ListOfContactsApplicationJson
ListOfContactsApplicationJsonUnderscoreLinks
ListOfConversationSearchResultsApplicationJson
ListOfConversationsApplicationJson
ListOfConversationsApplicationJsonUnderscoreLinks
ListOfCustomFieldsApplicationJson
ListOfCustomFieldsApplicationJsonUnderscoreLinks
ListOfEventsApplicationJson
ListOfEventsApplicationJsonUnderscoreLinks
ListOfInboxesApplicationJson
ListOfInboxesApplicationJsonUnderscoreLinks
ListOfLinksApplicationJson
ListOfLinksApplicationJsonUnderscoreLinks
ListOfMessagesApplicationJson
ListOfMessagesApplicationJsonUnderscoreLinks
ListOfRolesApplicationJson
ListOfRolesApplicationJsonUnderscoreLinks
ListOfRulesApplicationJson
ListOfRulesApplicationJsonUnderscoreLinks
ListOfSeenReceiptsApplicationJson
ListOfSeenReceiptsApplicationJsonUnderscoreLinks
ListOfShiftsApplicationJson
ListOfShiftsApplicationJsonUnderscoreLinks
ListOfSignaturesApplicationJson
ListOfSignaturesApplicationJsonUnderscoreLinks
ListOfTagsApplicationJson
ListOfTagsApplicationJsonUnderscoreLinks
ListOfTeammatesApplicationJson
ListOfTeammatesApplicationJsonUnderscoreLinks
ListOfTeamsApplicationJson
ListOfTeamsApplicationJsonUnderscoreLinks
ListRulesResponse
ListRulesResponseUnderscoreLinks
ListShiftTeammatesResponse
ListShiftTeammatesResponseUnderscoreLinks
ListShiftsResponse
ListShiftsResponseUnderscoreLinks
ListTagChildrenResponse
ListTagChildrenResponseUnderscoreLinks
ListTaggedConversationsResponse
ListTaggedConversationsResponseUnderscoreLinks
ListTagsResponse
ListTagsResponseUnderscoreLinks
ListTeamChannelsResponse
ListTeamChannelsResponseUnderscoreLinks
ListTeamContactsResponse
ListTeamContactsResponseUnderscoreLinks
ListTeamFoldersResponse
ListTeamFoldersResponseUnderscoreLinks
ListTeamGroupsResponse
ListTeamGroupsResponseUnderscoreLinks
ListTeamInboxesResponse
ListTeamInboxesResponseUnderscoreLinks
ListTeamMessageTemplatesResponse
ListTeamMessageTemplatesResponseUnderscoreLinks
ListTeamRulesResponse
ListTeamRulesResponseUnderscoreLinks
ListTeamShiftsResponse
ListTeamShiftsResponseUnderscoreLinks
ListTeamSignaturesResponse
ListTeamSignaturesResponseUnderscoreLinks
ListTeamTagsResponse
ListTeamTagsResponseUnderscoreLinks
ListTeammateChannelsResponse
ListTeammateChannelsResponseUnderscoreLinks
ListTeammateContactsResponse
ListTeammateContactsResponseUnderscoreLinks
ListTeammateFoldersResponse
ListTeammateFoldersResponseUnderscoreLinks
ListTeammateGroupsResponse
ListTeammateGroupsResponseUnderscoreLinks
ListTeammateInboxesResponse
ListTeammateInboxesResponseUnderscoreLinks
ListTeammateMessageTemplatesResponse
ListTeammateMessageTemplatesResponseUnderscoreLinks
ListTeammateRulesResponse
ListTeammateRulesResponseUnderscoreLinks
ListTeammateShiftsResponse
ListTeammateShiftsResponseUnderscoreLinks
ListTeammateSignaturesResponse
ListTeammateSignaturesResponseUnderscoreLinks
ListTeammateTagsResponse
ListTeammateTagsResponseUnderscoreLinks
ListTeammatesResponse
ListTeammatesResponseUnderscoreLinks
ListTeamsResponse
ListTeamsResponseUnderscoreLinks
MarkMessageSeenRequestBody
MergeContacts
MessageResponse
MessageResponseMetadata
Optional metadata about the message
MessageResponseUnderscoreLinks
MessageResponseUnderscoreLinksRelated
MessageTemplateFolderResponse
MessageTemplateFolderResponseUnderscoreLinks
MessageTemplateFolderResponseUnderscoreLinksRelated
MessageTemplateResponse
MessageTemplateResponseUnderscoreLinks
MessageTemplateResponseUnderscoreLinksRelated
Meta
Metadata about the resource
Metadata
Options
OutboundMessage
OutboundReplyMessage
OutboundReplyMessageOptions
Pagination
ReceiveCustomMessageResponse
RecipientResponse
RecipientResponseUnderscoreLinks
RecipientResponseUnderscoreLinksRelated
Related
Reminder
ReminderUnderscoreLinks
ReminderUnderscoreLinksRelated
RemoveConversationLinkRequestBody
ReplyDraft
Resource
ResourceUnderscoreLinks
RoleResponse
RoleResponseUnderscoreLinks
RoleResponseUnderscoreLinksRelated
RuleResponse
RuleResponseUnderscoreLinks
RuleResponseUnderscoreLinksRelated
SearchConversationsResponse
SeenReceiptResponse
SeenReceiptResponseUnderscoreLinks
SeenReceiptResponseUnderscoreLinksRelated
Sender
Data of the sender
Settings
Settings to replace. For custom channels, all settings may be replaced. For all other channels, only undo_send_time and all_teammates_can_reply may be replaced.
ShiftInterval
ShiftIntervals
ShiftResponse
ShiftResponseUnderscoreLinks
ShiftResponseUnderscoreLinksRelated
SignatureResponse
SignatureResponseUnderscoreLinks
SignatureResponseUnderscoreLinksRelated
TagIds
TagResponse
A tag is a label that can be used to classify conversations.
TagResponseUnderscoreLinks
TagResponseUnderscoreLinksRelated
Target
Partial representation (type & id) of the event’s target
TargetMeta
Metadata about the resource
TeamIds
TeamResponse
TeamResponseUnderscoreLinks
TeammateIds
TeammateResponse
A teammate is a user in Front.
TeammateResponseUnderscoreLinks
TeammateResponseUnderscoreLinksRelated
UnderscoreLinks
UpdateChannel
UpdateConversation
UpdateConversationAssignee
UpdateConversationReminders
UpdateCustomField
UpdateLink
UpdateMessageTemplate
UpdateMessageTemplateFolder
A message template folder that is used to store message templates or other folders.
UpdateShift
UpdateSignature
A signature that can be used to sign messages.
UpdateTag
UpdateTeammate
ValidateChannelResponse
ValueOneOf

Enums§

AnalyticsExportResponse2Status
Status of the analytics
AnalyticsMetricId
AnalyticsReportResponse2Status
Status of the report.
AnalyticsScalarType
BodyFormat
Format of the message body. Can be markdown (default) or html.
Color
Color of the shift
ConversationResponseStatus
Status of the conversation
CreateChannelType
Type of the channel
CreateConversationType
Conversation type
CustomFieldResponseType
Type of the custom field
Data
The resource which triggered the event
DraftMode
If the message is a draft, describes the draft mode. Can be ‘private’ (draft is visible to the author only) or ‘shared’ (draft is visible to all teammates with access to the conversation).
EditDraftMode
Mode of the draft to update. Can only be ‘shared’ (draft is visible to all teammates with access to the conversation).
EventResponseType
Type of event
Highlight
Highlight color of the tag.
ImportMessageBodyFormat
Format of the message body. Can be markdown (default) or html, and can only be specified for email type.
ImportMessageType
Type of the message to import. Default is email.
MessageResponseType
Type of the message
MetaType
Type of resource
Mode
Mode of the draft to create. Can be ‘private’ (draft is visible to the author only) or ‘shared’ (draft is visible to all teammates with access to the conversation).
Role
Role of the recipient
ShiftResponseColor
Color of the shift
SortOrder
Source
Source of the handle. Can be email, phone, twitter, facebook, intercom, front_chat, or custom.
Status
New status of the conversation
TargetMetaData
The resource which received the event
TargetMetaType
Type of resource
Type
Types
Type of the channel
Value
The value of a scalar metric.