@dugjason/front-node 0.1.0-beta.2 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/{LICENSE.md → LICENSE} +2 -2
- package/README.md +41 -258
- package/dist/index.cjs +2 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +11907 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.mts +11907 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +2 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +67 -38
- package/dist/client.d.ts +0 -53
- package/dist/client.d.ts.map +0 -1
- package/dist/client.js +0 -230
- package/dist/client.js.map +0 -1
- package/dist/core/client.d.ts +0 -36
- package/dist/core/client.d.ts.map +0 -1
- package/dist/core/client.js +0 -89
- package/dist/core/client.js.map +0 -1
- package/dist/core/errors.d.ts +0 -55
- package/dist/core/errors.d.ts.map +0 -1
- package/dist/core/errors.js +0 -124
- package/dist/core/errors.js.map +0 -1
- package/dist/core/paginator.d.ts +0 -88
- package/dist/core/paginator.d.ts.map +0 -1
- package/dist/core/paginator.js +0 -129
- package/dist/core/paginator.js.map +0 -1
- package/dist/core/resource.d.ts +0 -143
- package/dist/core/resource.d.ts.map +0 -1
- package/dist/core/resource.js +0 -132
- package/dist/core/resource.js.map +0 -1
- package/dist/endpoints/accounts.d.ts +0 -34
- package/dist/endpoints/accounts.d.ts.map +0 -1
- package/dist/endpoints/accounts.js +0 -85
- package/dist/endpoints/accounts.js.map +0 -1
- package/dist/endpoints/analytics.d.ts +0 -32
- package/dist/endpoints/analytics.d.ts.map +0 -1
- package/dist/endpoints/analytics.js +0 -48
- package/dist/endpoints/analytics.js.map +0 -1
- package/dist/endpoints/applications.d.ts +0 -15
- package/dist/endpoints/applications.d.ts.map +0 -1
- package/dist/endpoints/applications.js +0 -17
- package/dist/endpoints/applications.js.map +0 -1
- package/dist/endpoints/attachments.d.ts +0 -8
- package/dist/endpoints/attachments.d.ts.map +0 -1
- package/dist/endpoints/attachments.js +0 -10
- package/dist/endpoints/attachments.js.map +0 -1
- package/dist/endpoints/channels.d.ts +0 -41
- package/dist/endpoints/channels.d.ts.map +0 -1
- package/dist/endpoints/channels.js +0 -64
- package/dist/endpoints/channels.js.map +0 -1
- package/dist/endpoints/comments.d.ts +0 -30
- package/dist/endpoints/comments.d.ts.map +0 -1
- package/dist/endpoints/comments.js +0 -45
- package/dist/endpoints/comments.js.map +0 -1
- package/dist/endpoints/contacts.d.ts +0 -46
- package/dist/endpoints/contacts.d.ts.map +0 -1
- package/dist/endpoints/contacts.js +0 -99
- package/dist/endpoints/contacts.js.map +0 -1
- package/dist/endpoints/conversations.d.ts +0 -77
- package/dist/endpoints/conversations.d.ts.map +0 -1
- package/dist/endpoints/conversations.js +0 -221
- package/dist/endpoints/conversations.js.map +0 -1
- package/dist/endpoints/drafts.d.ts +0 -12
- package/dist/endpoints/drafts.d.ts.map +0 -1
- package/dist/endpoints/drafts.js +0 -26
- package/dist/endpoints/drafts.js.map +0 -1
- package/dist/endpoints/events.d.ts +0 -13
- package/dist/endpoints/events.d.ts.map +0 -1
- package/dist/endpoints/events.js +0 -21
- package/dist/endpoints/events.js.map +0 -1
- package/dist/endpoints/inboxes.d.ts +0 -42
- package/dist/endpoints/inboxes.d.ts.map +0 -1
- package/dist/endpoints/inboxes.js +0 -83
- package/dist/endpoints/inboxes.js.map +0 -1
- package/dist/endpoints/knowledge-base-articles.d.ts +0 -8
- package/dist/endpoints/knowledge-base-articles.d.ts.map +0 -1
- package/dist/endpoints/knowledge-base-articles.js +0 -10
- package/dist/endpoints/knowledge-base-articles.js.map +0 -1
- package/dist/endpoints/knowledge-bases.d.ts +0 -50
- package/dist/endpoints/knowledge-bases.d.ts.map +0 -1
- package/dist/endpoints/knowledge-bases.js +0 -131
- package/dist/endpoints/knowledge-bases.js.map +0 -1
- package/dist/endpoints/links.d.ts +0 -30
- package/dist/endpoints/links.d.ts.map +0 -1
- package/dist/endpoints/links.js +0 -67
- package/dist/endpoints/links.js.map +0 -1
- package/dist/endpoints/message-template-folders.d.ts +0 -38
- package/dist/endpoints/message-template-folders.d.ts.map +0 -1
- package/dist/endpoints/message-template-folders.js +0 -114
- package/dist/endpoints/message-template-folders.js.map +0 -1
- package/dist/endpoints/message-templates.d.ts +0 -30
- package/dist/endpoints/message-templates.d.ts.map +0 -1
- package/dist/endpoints/message-templates.js +0 -69
- package/dist/endpoints/message-templates.js.map +0 -1
- package/dist/endpoints/messages.d.ts +0 -21
- package/dist/endpoints/messages.d.ts.map +0 -1
- package/dist/endpoints/messages.js +0 -31
- package/dist/endpoints/messages.js.map +0 -1
- package/dist/endpoints/rules.d.ts +0 -16
- package/dist/endpoints/rules.d.ts.map +0 -1
- package/dist/endpoints/rules.js +0 -21
- package/dist/endpoints/rules.js.map +0 -1
- package/dist/endpoints/shifts.d.ts +0 -46
- package/dist/endpoints/shifts.d.ts.map +0 -1
- package/dist/endpoints/shifts.js +0 -70
- package/dist/endpoints/shifts.js.map +0 -1
- package/dist/endpoints/signatures.d.ts +0 -36
- package/dist/endpoints/signatures.d.ts.map +0 -1
- package/dist/endpoints/signatures.js +0 -52
- package/dist/endpoints/signatures.js.map +0 -1
- package/dist/endpoints/statuses.d.ts +0 -15
- package/dist/endpoints/statuses.d.ts.map +0 -1
- package/dist/endpoints/statuses.js +0 -22
- package/dist/endpoints/statuses.js.map +0 -1
- package/dist/endpoints/tags.d.ts +0 -30
- package/dist/endpoints/tags.d.ts.map +0 -1
- package/dist/endpoints/tags.js +0 -49
- package/dist/endpoints/tags.js.map +0 -1
- package/dist/endpoints/teammate-groups.d.ts +0 -47
- package/dist/endpoints/teammate-groups.d.ts.map +0 -1
- package/dist/endpoints/teammate-groups.js +0 -101
- package/dist/endpoints/teammate-groups.js.map +0 -1
- package/dist/endpoints/teammates.d.ts +0 -28
- package/dist/endpoints/teammates.d.ts.map +0 -1
- package/dist/endpoints/teammates.js +0 -59
- package/dist/endpoints/teammates.js.map +0 -1
- package/dist/endpoints/teams.d.ts +0 -37
- package/dist/endpoints/teams.d.ts.map +0 -1
- package/dist/endpoints/teams.js +0 -79
- package/dist/endpoints/teams.js.map +0 -1
- package/dist/front.d.ts +0 -103
- package/dist/front.d.ts.map +0 -1
- package/dist/front.js +0 -162
- package/dist/front.js.map +0 -1
- package/dist/generated/client/client.gen.d.ts +0 -3
- package/dist/generated/client/client.gen.d.ts.map +0 -1
- package/dist/generated/client/client.gen.js +0 -204
- package/dist/generated/client/client.gen.js.map +0 -1
- package/dist/generated/client/index.d.ts +0 -8
- package/dist/generated/client/index.d.ts.map +0 -1
- package/dist/generated/client/index.js +0 -6
- package/dist/generated/client/index.js.map +0 -1
- package/dist/generated/client/types.gen.d.ts +0 -125
- package/dist/generated/client/types.gen.d.ts.map +0 -1
- package/dist/generated/client/types.gen.js +0 -3
- package/dist/generated/client/types.gen.js.map +0 -1
- package/dist/generated/client/utils.gen.d.ts +0 -39
- package/dist/generated/client/utils.gen.d.ts.map +0 -1
- package/dist/generated/client/utils.gen.js +0 -230
- package/dist/generated/client/utils.gen.js.map +0 -1
- package/dist/generated/client.gen.d.ts +0 -13
- package/dist/generated/client.gen.d.ts.map +0 -1
- package/dist/generated/client.gen.js +0 -6
- package/dist/generated/client.gen.js.map +0 -1
- package/dist/generated/core/auth.gen.d.ts +0 -19
- package/dist/generated/core/auth.gen.d.ts.map +0 -1
- package/dist/generated/core/auth.gen.js +0 -15
- package/dist/generated/core/auth.gen.js.map +0 -1
- package/dist/generated/core/bodySerializer.gen.d.ts +0 -18
- package/dist/generated/core/bodySerializer.gen.d.ts.map +0 -1
- package/dist/generated/core/bodySerializer.gen.js +0 -58
- package/dist/generated/core/bodySerializer.gen.js.map +0 -1
- package/dist/generated/core/params.gen.d.ts +0 -34
- package/dist/generated/core/params.gen.d.ts.map +0 -1
- package/dist/generated/core/params.gen.js +0 -89
- package/dist/generated/core/params.gen.js.map +0 -1
- package/dist/generated/core/pathSerializer.gen.d.ts +0 -34
- package/dist/generated/core/pathSerializer.gen.d.ts.map +0 -1
- package/dist/generated/core/pathSerializer.gen.js +0 -115
- package/dist/generated/core/pathSerializer.gen.js.map +0 -1
- package/dist/generated/core/serverSentEvents.gen.d.ts +0 -72
- package/dist/generated/core/serverSentEvents.gen.d.ts.map +0 -1
- package/dist/generated/core/serverSentEvents.gen.js +0 -136
- package/dist/generated/core/serverSentEvents.gen.js.map +0 -1
- package/dist/generated/core/types.gen.d.ts +0 -79
- package/dist/generated/core/types.gen.d.ts.map +0 -1
- package/dist/generated/core/types.gen.js +0 -3
- package/dist/generated/core/types.gen.js.map +0 -1
- package/dist/generated/core/utils.gen.d.ts +0 -15
- package/dist/generated/core/utils.gen.d.ts.map +0 -1
- package/dist/generated/core/utils.gen.js +0 -70
- package/dist/generated/core/utils.gen.js.map +0 -1
- package/dist/generated/sdk.gen.d.ts +0 -1292
- package/dist/generated/sdk.gen.d.ts.map +0 -1
- package/dist/generated/sdk.gen.js +0 -4202
- package/dist/generated/sdk.gen.js.map +0 -1
- package/dist/generated/types.gen.d.ts +0 -8492
- package/dist/generated/types.gen.d.ts.map +0 -1
- package/dist/generated/types.gen.js +0 -149
- package/dist/generated/types.gen.js.map +0 -1
- package/dist/index.d.ts +0 -28
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js +0 -6
- package/dist/index.js.map +0 -1
- package/dist/oauth.d.ts +0 -28
- package/dist/oauth.d.ts.map +0 -1
- package/dist/oauth.js +0 -82
- package/dist/oauth.js.map +0 -1
- package/dist/resources/accounts.d.ts +0 -16
- package/dist/resources/accounts.d.ts.map +0 -1
- package/dist/resources/accounts.js +0 -37
- package/dist/resources/accounts.js.map +0 -1
- package/dist/resources/analytics.d.ts +0 -36
- package/dist/resources/analytics.d.ts.map +0 -1
- package/dist/resources/analytics.js +0 -82
- package/dist/resources/analytics.js.map +0 -1
- package/dist/resources/applications.d.ts +0 -9
- package/dist/resources/applications.d.ts.map +0 -1
- package/dist/resources/applications.js +0 -13
- package/dist/resources/applications.js.map +0 -1
- package/dist/resources/channels.d.ts +0 -18
- package/dist/resources/channels.d.ts.map +0 -1
- package/dist/resources/channels.js +0 -35
- package/dist/resources/channels.js.map +0 -1
- package/dist/resources/comments.d.ts +0 -18
- package/dist/resources/comments.d.ts.map +0 -1
- package/dist/resources/comments.js +0 -36
- package/dist/resources/comments.js.map +0 -1
- package/dist/resources/contacts.d.ts +0 -16
- package/dist/resources/contacts.d.ts.map +0 -1
- package/dist/resources/contacts.js +0 -37
- package/dist/resources/contacts.js.map +0 -1
- package/dist/resources/conversations.d.ts +0 -24
- package/dist/resources/conversations.d.ts.map +0 -1
- package/dist/resources/conversations.js +0 -55
- package/dist/resources/conversations.js.map +0 -1
- package/dist/resources/drafts.d.ts +0 -15
- package/dist/resources/drafts.d.ts.map +0 -1
- package/dist/resources/drafts.js +0 -34
- package/dist/resources/drafts.js.map +0 -1
- package/dist/resources/events.d.ts +0 -23
- package/dist/resources/events.d.ts.map +0 -1
- package/dist/resources/events.js +0 -28
- package/dist/resources/events.js.map +0 -1
- package/dist/resources/inboxes.d.ts +0 -12
- package/dist/resources/inboxes.d.ts.map +0 -1
- package/dist/resources/inboxes.js +0 -25
- package/dist/resources/inboxes.js.map +0 -1
- package/dist/resources/knowledge-base-articles.d.ts +0 -15
- package/dist/resources/knowledge-base-articles.d.ts.map +0 -1
- package/dist/resources/knowledge-base-articles.js +0 -34
- package/dist/resources/knowledge-base-articles.js.map +0 -1
- package/dist/resources/knowledge-base-categories.d.ts +0 -16
- package/dist/resources/knowledge-base-categories.d.ts.map +0 -1
- package/dist/resources/knowledge-base-categories.js +0 -37
- package/dist/resources/knowledge-base-categories.js.map +0 -1
- package/dist/resources/knowledge-bases.d.ts +0 -15
- package/dist/resources/knowledge-bases.d.ts.map +0 -1
- package/dist/resources/knowledge-bases.js +0 -35
- package/dist/resources/knowledge-bases.js.map +0 -1
- package/dist/resources/links.d.ts +0 -12
- package/dist/resources/links.d.ts.map +0 -1
- package/dist/resources/links.js +0 -25
- package/dist/resources/links.js.map +0 -1
- package/dist/resources/message-template-folders.d.ts +0 -13
- package/dist/resources/message-template-folders.d.ts.map +0 -1
- package/dist/resources/message-template-folders.js +0 -41
- package/dist/resources/message-template-folders.js.map +0 -1
- package/dist/resources/message-templates.d.ts +0 -16
- package/dist/resources/message-templates.d.ts.map +0 -1
- package/dist/resources/message-templates.js +0 -50
- package/dist/resources/message-templates.js.map +0 -1
- package/dist/resources/messages.d.ts +0 -36
- package/dist/resources/messages.d.ts.map +0 -1
- package/dist/resources/messages.js +0 -55
- package/dist/resources/messages.js.map +0 -1
- package/dist/resources/rules.d.ts +0 -11
- package/dist/resources/rules.d.ts.map +0 -1
- package/dist/resources/rules.js +0 -22
- package/dist/resources/rules.js.map +0 -1
- package/dist/resources/shifts.d.ts +0 -14
- package/dist/resources/shifts.d.ts.map +0 -1
- package/dist/resources/shifts.js +0 -31
- package/dist/resources/shifts.js.map +0 -1
- package/dist/resources/signatures.d.ts +0 -17
- package/dist/resources/signatures.d.ts.map +0 -1
- package/dist/resources/signatures.js +0 -51
- package/dist/resources/signatures.js.map +0 -1
- package/dist/resources/statuses.d.ts +0 -13
- package/dist/resources/statuses.d.ts.map +0 -1
- package/dist/resources/statuses.js +0 -28
- package/dist/resources/statuses.js.map +0 -1
- package/dist/resources/tags.d.ts +0 -17
- package/dist/resources/tags.d.ts.map +0 -1
- package/dist/resources/tags.js +0 -53
- package/dist/resources/tags.js.map +0 -1
- package/dist/resources/teammate-groups.d.ts +0 -17
- package/dist/resources/teammate-groups.d.ts.map +0 -1
- package/dist/resources/teammate-groups.js +0 -25
- package/dist/resources/teammate-groups.js.map +0 -1
- package/dist/resources/teammates.d.ts +0 -17
- package/dist/resources/teammates.d.ts.map +0 -1
- package/dist/resources/teammates.js +0 -40
- package/dist/resources/teammates.js.map +0 -1
- package/dist/resources/teams.d.ts +0 -11
- package/dist/resources/teams.d.ts.map +0 -1
- package/dist/resources/teams.js +0 -28
- package/dist/resources/teams.js.map +0 -1
- package/dist/types.d.ts +0 -46
- package/dist/types.d.ts.map +0 -1
- package/dist/types.js +0 -2
- package/dist/types.js.map +0 -1
|
@@ -1,1292 +0,0 @@
|
|
|
1
|
-
import type { Options as ClientOptions, TDataShape, Client } from './client';
|
|
2
|
-
import type { ListAccountsData, ListAccountsResponses, CreateAccountData, CreateAccountResponses, ListAccountCustomFieldsData, ListAccountCustomFieldsResponses, DeleteAnAccountData, DeleteAnAccountResponses, FetchAnAccountData, FetchAnAccountResponses, UpdateAccountData, UpdateAccountResponses, RemoveContactFromAccountData, RemoveContactFromAccountResponses, ListAccountContactsData, ListAccountContactsResponses, AddContactToAccountData, AddContactToAccountResponses, CreateAnalyticsExportData, CreateAnalyticsExportResponses, GetAnalyticsExportData, GetAnalyticsExportResponses, CreateAnalyticsReportData, CreateAnalyticsReportResponses, GetAnalyticsReportData, GetAnalyticsReportResponses, TriggerAppEventData, TriggerAppEventResponses, ListChannelsData, ListChannelsResponses, GetChannelData, GetChannelResponses, UpdateChannelData, UpdateChannelResponses, CreateDraftData, CreateDraftResponses, ReceiveCustomMessagesData, ReceiveCustomMessagesResponses, CreateMessageData, CreateMessageResponses, ValidateChannelData, ValidateChannelResponses, GetCommentData, GetCommentResponses, UpdateCommentData, UpdateCommentResponses, DownloadAttachmentForACommentData, DownloadAttachmentForACommentResponses, ListCommentMentionsData, ListCommentMentionsResponses, AddCommentReplyData, AddCommentReplyResponses, ListAllCompanyRulesData, ListAllCompanyRulesResponses, ListCompanyTicketStatusesData, ListCompanyTicketStatusesResponses, ListCompanyTicketStatusesErrors, GetTicketStatusByIdData, GetTicketStatusByIdResponses, ListCompanyTagsData, ListCompanyTagsResponses, CreateCompanyTagData, CreateCompanyTagResponses, ListGroupsData, ListGroupsResponses, CreateGroupData, CreateGroupResponses, DeleteGroupData, DeleteGroupResponses, RemoveContactsFromGroupData, RemoveContactsFromGroupResponses, ListContactsInGroupData, ListContactsInGroupResponses, AddContactsToGroupData, AddContactsToGroupResponses, ListContactListsData, ListContactListsResponses, CreateContactListData, CreateContactListResponses, DeleteContactListData, DeleteContactListResponses, RemoveContactsFromContactListData, RemoveContactsFromContactListResponses, ListContactsInContactListData, ListContactsInContactListResponses, AddContactsToContactListData, AddContactsToContactListResponses, ListContactsData, ListContactsResponses, CreateContactData, CreateContactResponses, ListContactCustomFieldsData, ListContactCustomFieldsResponses, MergeContactsData, MergeContactsResponses, DeleteAContactData, DeleteAContactResponses, GetContactData, GetContactResponses, UpdateAContactData, UpdateAContactResponses, ListContactConversationsData, ListContactConversationsResponses, DeleteContactHandleData, DeleteContactHandleResponses, AddContactHandleData, AddContactHandleResponses, ListNotesData, ListNotesResponses, AddNoteData, AddNoteResponses, ListConversationsData, ListConversationsResponses, CreateConversationData, CreateConversationResponses, ListConversationCustomFieldsData, ListConversationCustomFieldsResponses, SearchConversationsData, SearchConversationsResponses, GetConversationByIdData, GetConversationByIdResponses, UpdateConversationData, UpdateConversationResponses, UpdateConversationErrors, UpdateConversationAssigneeData, UpdateConversationAssigneeResponses, ListConversationCommentsData, ListConversationCommentsResponses, AddCommentData, AddCommentResponses, ListConversationDraftsData, ListConversationDraftsResponses, CreateDraftReplyData, CreateDraftReplyResponses, ListConversationEventsData, ListConversationEventsResponses, DeleteConversationFollowersData, DeleteConversationFollowersResponses, ListConversationFollowersData, ListConversationFollowersResponses, AddConversationFollowersData, AddConversationFollowersResponses, ListConversationInboxesData, ListConversationInboxesResponses, RemoveConversationLinksData, RemoveConversationLinksResponses, AddConversationLinkData, AddConversationLinkResponses, ListConversationMessagesData, ListConversationMessagesResponses, CreateMessageReplyData, CreateMessageReplyResponses, UpdateConversationRemindersData, UpdateConversationRemindersResponses, RemoveConversationTagData, RemoveConversationTagResponses, AddConversationTagData, AddConversationTagResponses, ListCustomFieldsData, ListCustomFieldsResponses, DownloadAttachmentData, DownloadAttachmentResponses, DeleteDraftData, DeleteDraftResponses, EditDraftData, EditDraftResponses, ListEventsData, ListEventsResponses, GetEventData, GetEventResponses, ListInboxesData, ListInboxesResponses, CreateInboxData, CreateInboxResponses, ListInboxCustomFieldsData, ListInboxCustomFieldsResponses, GetInboxData, GetInboxResponses, ListInboxChannelsData, ListInboxChannelsResponses, CreateAChannelData, CreateAChannelResponses, ListInboxConversationsData, ListInboxConversationsResponses, ImportInboxMessageData, ImportInboxMessageResponses, RemovesInboxAccessData, RemovesInboxAccessResponses, ListInboxAccessData, ListInboxAccessResponses, AddInboxAccessData, AddInboxAccessResponses, DeleteAnArticleData, DeleteAnArticleResponses, GetAKnowledgeBaseArticleData, GetAKnowledgeBaseArticleResponses, GetKnowledgeBaseArticleWithContentInDefaultLocaleData, GetKnowledgeBaseArticleWithContentInDefaultLocaleResponses, UpdateArticleContentInDefaultLocaleData, UpdateArticleContentInDefaultLocaleResponses, DownloadAttachmentFromAnArticleData, DownloadAttachmentFromAnArticleResponses, GetKnowledgeBaseArticleWithContentInSpecifiedLocaleData, GetKnowledgeBaseArticleWithContentInSpecifiedLocaleResponses, UpdateArticleContentInSpecifiedLocaleData, UpdateArticleContentInSpecifiedLocaleResponses, DeleteAKnowledgeBaseCategoryData, DeleteAKnowledgeBaseCategoryResponses, GetAKnowledgeBaseCategoryData, GetAKnowledgeBaseCategoryResponses, ListArticlesInACategoryData, ListArticlesInACategoryResponses, GetKnowledgeBaseCategoryContentInDefaultLocaleData, GetKnowledgeBaseCategoryContentInDefaultLocaleResponses, UpdateKnowledgeBaseCategoryInDefaultLocaleData, UpdateKnowledgeBaseCategoryInDefaultLocaleResponses, GetKnowledgeBaseCategoryWithContentInSpecifiedLocaleData, GetKnowledgeBaseCategoryWithContentInSpecifiedLocaleResponses, UpdateKnowledgeBaseCategoryInSpecifiedLocaleData, UpdateKnowledgeBaseCategoryInSpecifiedLocaleResponses, ListKnowledgeBasesData, ListKnowledgeBasesResponses, CreateAKnowledgeBaseData, CreateAKnowledgeBaseResponses, GetAKnowledgeBaseData, GetAKnowledgeBaseResponses, ListArticlesInAKnowledgeBaseData, ListArticlesInAKnowledgeBaseResponses, CreateArticleInAKnowledgeBaseInDefaultLocaleData, CreateArticleInAKnowledgeBaseInDefaultLocaleResponses, ListCategoriesInAKnowledgeBaseData, ListCategoriesInAKnowledgeBaseResponses, CreateKnowledgeBaseCategoryInDefaultLocaleData, CreateKnowledgeBaseCategoryInDefaultLocaleResponses, GetAKnowledgeBaseWithContentInDefaultLocaleData, GetAKnowledgeBaseWithContentInDefaultLocaleResponses, UpdateKnowledgeBaseInDefaultLocaleData, UpdateKnowledgeBaseInDefaultLocaleResponses, CreateArticleInAKnowledgeBaseInSpecifiedLocaleData, CreateArticleInAKnowledgeBaseInSpecifiedLocaleResponses, CreateKnowledgeBaseCategoryInSpecifiedLocaleData, CreateKnowledgeBaseCategoryInSpecifiedLocaleResponses, GetAKnowledgeBaseWithContentInSpecifiedLocaleData, GetAKnowledgeBaseWithContentInSpecifiedLocaleResponses, UpdateKnowledgeBaseInSpecifiedLocaleData, UpdateKnowledgeBaseInSpecifiedLocaleResponses, ListLinksData, ListLinksResponses, CreateLinkData, CreateLinkResponses, ListLinkCustomFieldsData, ListLinkCustomFieldsResponses, GetLinkData, GetLinkResponses, UpdateALinkData, UpdateALinkResponses, ListLinkConversationsData, ListLinkConversationsResponses, ApiTokenDetailsData, ApiTokenDetailsResponses, ListFoldersData, ListFoldersResponses, CreateFolderData, CreateFolderResponses, DeleteFolderData, DeleteFolderResponses, GetFolderData, GetFolderResponses, UpdateFolderData, UpdateFolderResponses, GetChildFoldersData, GetChildFoldersResponses, CreateChildFolderData, CreateChildFolderResponses, GetChildTemplatesData, GetChildTemplatesResponses, CreateChildTemplateData, CreateChildTemplateResponses, ListMessageTemplatesData, ListMessageTemplatesResponses, CreateMessageTemplateData, CreateMessageTemplateResponses, DeleteMessageTemplateData, DeleteMessageTemplateResponses, GetMessageTemplateData, GetMessageTemplateResponses, UpdateMessageTemplateData, UpdateMessageTemplateResponses, DownloadAttachmentForAMessageTemplateData, DownloadAttachmentForAMessageTemplateResponses, GetMessageData, GetMessageResponses, DownloadAttachmentForAMessageData, DownloadAttachmentForAMessageResponses, GetMessageSeenStatusData, GetMessageSeenStatusResponses, MarkMessageSeenData, MarkMessageSeenResponses, ListRulesData, ListRulesResponses, GetRuleData, GetRuleResponses, ListShiftsData, ListShiftsResponses, CreateShiftData, CreateShiftResponses, GetShiftData, GetShiftResponses, UpdateShiftData, UpdateShiftResponses, RemoveTeammatesFromShiftData, RemoveTeammatesFromShiftResponses, ListShiftsTeammatesData, ListShiftsTeammatesResponses, AddTeammatesToShiftData, AddTeammatesToShiftResponses, DeleteSignatureData, DeleteSignatureResponses, GetSignaturesData, GetSignaturesResponses, UpdateSignatureData, UpdateSignatureResponses, ListTagsData, ListTagsResponses, CreateTagData, CreateTagResponses, DeleteTagData, DeleteTagResponses, GetTagData, GetTagResponses, UpdateATagData, UpdateATagResponses, ListTagChildrenData, ListTagChildrenResponses, CreateChildTagData, CreateChildTagResponses, ListTaggedConversationsData, ListTaggedConversationsResponses, ListCompanyTeammateGroupsData, ListCompanyTeammateGroupsResponses, CreateCompanyTeammateGroupData, CreateCompanyTeammateGroupResponses, DeleteCompanyTeammateGroupData, DeleteCompanyTeammateGroupResponses, GetCompanyTeammateGroupData, GetCompanyTeammateGroupResponses, UpdateACompanyTeammateGroupData, UpdateACompanyTeammateGroupResponses, RemoveCompanyTeammateGroupTeamInboxesData, RemoveCompanyTeammateGroupTeamInboxesResponses, ListCompanyTeammateGroupTeamInboxesData, ListCompanyTeammateGroupTeamInboxesResponses, AddCompanyTeammateGroupTeamInboxesData, AddCompanyTeammateGroupTeamInboxesResponses, RemoveCompanyTeammateGroupTeammatesData, RemoveCompanyTeammateGroupTeammatesResponses, ListCompanyTeammateGroupTeammatesData, ListCompanyTeammateGroupTeammatesResponses, AddCompanyTeammateGroupTeammatesData, AddCompanyTeammateGroupTeammatesResponses, RemoveCompanyTeammateGroupTeamsData, RemoveCompanyTeammateGroupTeamsResponses, ListCompanyTeammateGroupTeamsData, ListCompanyTeammateGroupTeamsResponses, AddCompanyTeammateGroupTeamsData, AddCompanyTeammateGroupTeamsResponses, ListTeammatesData, ListTeammatesResponses, ListTeammateCustomFieldsData, ListTeammateCustomFieldsResponses, GetTeammateData, GetTeammateResponses, UpdateTeammateData, UpdateTeammateResponses, ListTeammateChannelsData, ListTeammateChannelsResponses, ListTeammateGroupsData, ListTeammateGroupsResponses, CreateTeammateGroupData, CreateTeammateGroupResponses, ListTeammateContactListsData, ListTeammateContactListsResponses, CreateTeammateContactListData, CreateTeammateContactListResponses, ListTeammateContactsData, ListTeammateContactsResponses, CreateTeammateContactData, CreateTeammateContactResponses, ListAssignedConversationsData, ListAssignedConversationsResponses, ListTeammateInboxesData, ListTeammateInboxesResponses, ListTeammateFoldersData, ListTeammateFoldersResponses, CreateTeammateFolderData, CreateTeammateFolderResponses, ListTeammateMessageTemplatesData, ListTeammateMessageTemplatesResponses, CreateTeammateMessageTemplateData, CreateTeammateMessageTemplateResponses, ListTeammateRulesData, ListTeammateRulesResponses, ListTeammateShiftsData, ListTeammateShiftsResponses, ListTeammateSignaturesData, ListTeammateSignaturesResponses, CreateTeammateSignatureData, CreateTeammateSignatureResponses, ListTeammateTagsData, ListTeammateTagsResponses, CreateTeammateTagData, CreateTeammateTagResponses, ListTeamsData, ListTeamsResponses, GetTeamData, GetTeamResponses, ListTeamChannelsData, ListTeamChannelsResponses, ListTeamGroupsData, ListTeamGroupsResponses, CreateTeamGroupData, CreateTeamGroupResponses, ListTeamContactListsData, ListTeamContactListsResponses, CreateTeamContactListData, CreateTeamContactListResponses, ListTeamContactsData, ListTeamContactsResponses, CreateTeamContactData, CreateTeamContactResponses, ListTeamInboxesData, ListTeamInboxesResponses, CreateTeamInboxData, CreateTeamInboxResponses, ListTeamFoldersData, ListTeamFoldersResponses, CreateTeamFolderData, CreateTeamFolderResponses, ListTeamMessageTemplatesData, ListTeamMessageTemplatesResponses, CreateTeamMessageTemplateData, CreateTeamMessageTemplateResponses, ListTeamRulesData, ListTeamRulesResponses, ListTeamShiftsData, ListTeamShiftsResponses, CreateTeamShiftData, CreateTeamShiftResponses, ListTeamSignaturesData, ListTeamSignaturesResponses, CreateTeamSignatureData, CreateTeamSignatureResponses, ListTeamTagsData, ListTeamTagsResponses, CreateTeamTagData, CreateTeamTagResponses, RemoveTeammatesFromTeamData, RemoveTeammatesFromTeamResponses, AddTeammatesToTeamData, AddTeammatesToTeamResponses } from './types.gen';
|
|
3
|
-
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
|
|
4
|
-
/**
|
|
5
|
-
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
-
* individual options. This might be also useful if you want to implement a
|
|
7
|
-
* custom client.
|
|
8
|
-
*/
|
|
9
|
-
client?: Client;
|
|
10
|
-
/**
|
|
11
|
-
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
-
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
-
*/
|
|
14
|
-
meta?: Record<string, unknown>;
|
|
15
|
-
};
|
|
16
|
-
/**
|
|
17
|
-
* List Accounts
|
|
18
|
-
* List the accounts of the company.
|
|
19
|
-
*/
|
|
20
|
-
export declare const listAccounts: <ThrowOnError extends boolean = false>(options?: Options<ListAccountsData, ThrowOnError>) => import("./client").RequestResult<ListAccountsResponses, unknown, ThrowOnError, "fields">;
|
|
21
|
-
/**
|
|
22
|
-
* Create account
|
|
23
|
-
* Create a new account.
|
|
24
|
-
*/
|
|
25
|
-
export declare const createAccount: <ThrowOnError extends boolean = false>(options?: Options<CreateAccountData, ThrowOnError>) => import("./client").RequestResult<CreateAccountResponses, unknown, ThrowOnError, "fields">;
|
|
26
|
-
/**
|
|
27
|
-
* List Account's custom fields
|
|
28
|
-
* Lists the custom fields that can be attached to an Account.
|
|
29
|
-
*/
|
|
30
|
-
export declare const listAccountCustomFields: <ThrowOnError extends boolean = false>(options?: Options<ListAccountCustomFieldsData, ThrowOnError>) => import("./client").RequestResult<ListAccountCustomFieldsResponses, unknown, ThrowOnError, "fields">;
|
|
31
|
-
/**
|
|
32
|
-
* Delete an account
|
|
33
|
-
* Deletes an account
|
|
34
|
-
*/
|
|
35
|
-
export declare const deleteAnAccount: <ThrowOnError extends boolean = false>(options: Options<DeleteAnAccountData, ThrowOnError>) => import("./client").RequestResult<DeleteAnAccountResponses, unknown, ThrowOnError, "fields">;
|
|
36
|
-
/**
|
|
37
|
-
* Fetch an account
|
|
38
|
-
* Fetches an account
|
|
39
|
-
*/
|
|
40
|
-
export declare const fetchAnAccount: <ThrowOnError extends boolean = false>(options: Options<FetchAnAccountData, ThrowOnError>) => import("./client").RequestResult<FetchAnAccountResponses, unknown, ThrowOnError, "fields">;
|
|
41
|
-
/**
|
|
42
|
-
* Update account
|
|
43
|
-
* Updates an account.
|
|
44
|
-
*/
|
|
45
|
-
export declare const updateAccount: <ThrowOnError extends boolean = false>(options: Options<UpdateAccountData, ThrowOnError>) => import("./client").RequestResult<UpdateAccountResponses, unknown, ThrowOnError, "fields">;
|
|
46
|
-
/**
|
|
47
|
-
* Remove contact from Account
|
|
48
|
-
* Removes a list of contacts from an Account
|
|
49
|
-
*/
|
|
50
|
-
export declare const removeContactFromAccount: <ThrowOnError extends boolean = false>(options: Options<RemoveContactFromAccountData, ThrowOnError>) => import("./client").RequestResult<RemoveContactFromAccountResponses, unknown, ThrowOnError, "fields">;
|
|
51
|
-
/**
|
|
52
|
-
* List account contacts
|
|
53
|
-
* Lists the contacts associated with an Account
|
|
54
|
-
*/
|
|
55
|
-
export declare const listAccountContacts: <ThrowOnError extends boolean = false>(options: Options<ListAccountContactsData, ThrowOnError>) => import("./client").RequestResult<ListAccountContactsResponses, unknown, ThrowOnError, "fields">;
|
|
56
|
-
/**
|
|
57
|
-
* Add contact to Account
|
|
58
|
-
* Adds a list of contacts to an Account
|
|
59
|
-
*/
|
|
60
|
-
export declare const addContactToAccount: <ThrowOnError extends boolean = false>(options: Options<AddContactToAccountData, ThrowOnError>) => import("./client").RequestResult<AddContactToAccountResponses, unknown, ThrowOnError, "fields">;
|
|
61
|
-
/**
|
|
62
|
-
* Create a new analytics export
|
|
63
|
-
* Create a new analytics export of messages or events (activities) over a specific time span.
|
|
64
|
-
* The export will be executed asynchronously. The response will include a link that can be used to retrieve the export status & result. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.
|
|
65
|
-
*
|
|
66
|
-
*/
|
|
67
|
-
export declare const createAnalyticsExport: <ThrowOnError extends boolean = false>(options?: Options<CreateAnalyticsExportData, ThrowOnError>) => import("./client").RequestResult<CreateAnalyticsExportResponses, unknown, ThrowOnError, "fields">;
|
|
68
|
-
/**
|
|
69
|
-
* Fetch an analytics export
|
|
70
|
-
* Fetch an analytics exports. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.
|
|
71
|
-
*/
|
|
72
|
-
export declare const getAnalyticsExport: <ThrowOnError extends boolean = false>(options: Options<GetAnalyticsExportData, ThrowOnError>) => import("./client").RequestResult<GetAnalyticsExportResponses, unknown, ThrowOnError, "fields">;
|
|
73
|
-
/**
|
|
74
|
-
* Create a new analytics report
|
|
75
|
-
* Create a new analytics report for a set of metrics over a specific time span. Different filters (e.g. Inbox v Tag v Teammates) will be joined with AND logic, but the IDs within a filter will be joined with OR logic (e.g. Inbox A or Inbox B, Tag A or Tag B).
|
|
76
|
-
* The report will be executed asynchronously. The response will include a link that can be used to retrieve the
|
|
77
|
-
* report status & result. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.
|
|
78
|
-
*
|
|
79
|
-
*/
|
|
80
|
-
export declare const createAnalyticsReport: <ThrowOnError extends boolean = false>(options?: Options<CreateAnalyticsReportData, ThrowOnError>) => import("./client").RequestResult<CreateAnalyticsReportResponses, unknown, ThrowOnError, "fields">;
|
|
81
|
-
/**
|
|
82
|
-
* Fetch an analytics report
|
|
83
|
-
* Fetch an analytics report. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.
|
|
84
|
-
*/
|
|
85
|
-
export declare const getAnalyticsReport: <ThrowOnError extends boolean = false>(options: Options<GetAnalyticsReportData, ThrowOnError>) => import("./client").RequestResult<GetAnalyticsReportResponses, unknown, ThrowOnError, "fields">;
|
|
86
|
-
/**
|
|
87
|
-
* Trigger application event
|
|
88
|
-
* Triggers an event on behalf of an application. These events can trigger Front workflows, like rules.
|
|
89
|
-
* For more information, see the [developer docs](https://dev.frontapp.com/docs/application-triggers#/).
|
|
90
|
-
*
|
|
91
|
-
*/
|
|
92
|
-
export declare const triggerAppEvent: <ThrowOnError extends boolean = false>(options: Options<TriggerAppEventData, ThrowOnError>) => import("./client").RequestResult<TriggerAppEventResponses, unknown, ThrowOnError, "fields">;
|
|
93
|
-
/**
|
|
94
|
-
* List channels
|
|
95
|
-
* List the channels of the company.
|
|
96
|
-
*/
|
|
97
|
-
export declare const listChannels: <ThrowOnError extends boolean = false>(options?: Options<ListChannelsData, ThrowOnError>) => import("./client").RequestResult<ListChannelsResponses, unknown, ThrowOnError, "fields">;
|
|
98
|
-
/**
|
|
99
|
-
* Get channel
|
|
100
|
-
* Fetch a channel.
|
|
101
|
-
*/
|
|
102
|
-
export declare const getChannel: <ThrowOnError extends boolean = false>(options: Options<GetChannelData, ThrowOnError>) => import("./client").RequestResult<GetChannelResponses, unknown, ThrowOnError, "fields">;
|
|
103
|
-
/**
|
|
104
|
-
* Update Channel
|
|
105
|
-
* Update a channel.
|
|
106
|
-
*/
|
|
107
|
-
export declare const updateChannel: <ThrowOnError extends boolean = false>(options: Options<UpdateChannelData, ThrowOnError>) => import("./client").RequestResult<UpdateChannelResponses, unknown, ThrowOnError, "fields">;
|
|
108
|
-
/**
|
|
109
|
-
* Create draft
|
|
110
|
-
* Create a draft message which is the first message of a new [conversation](https://dev.frontapp.com/reference/conversations).
|
|
111
|
-
*/
|
|
112
|
-
export declare const createDraft: <ThrowOnError extends boolean = false>(options: Options<CreateDraftData, ThrowOnError>) => import("./client").RequestResult<CreateDraftResponses, unknown, ThrowOnError, "fields">;
|
|
113
|
-
/**
|
|
114
|
-
* Receive custom messages
|
|
115
|
-
* Receive a custom message in Front. This endpoint is available for custom channels **ONLY**.
|
|
116
|
-
*/
|
|
117
|
-
export declare const receiveCustomMessages: <ThrowOnError extends boolean = false>(options: Options<ReceiveCustomMessagesData, ThrowOnError>) => import("./client").RequestResult<ReceiveCustomMessagesResponses, unknown, ThrowOnError, "fields">;
|
|
118
|
-
/**
|
|
119
|
-
* Create message
|
|
120
|
-
* Send a new message from a channel. This is one of the ways to create a new [conversation](https://dev.frontapp.com/reference/conversations#creating-a-new-conversation). The new conversation will support both messages and comments (discussions).
|
|
121
|
-
*/
|
|
122
|
-
export declare const createMessage: <ThrowOnError extends boolean = false>(options: Options<CreateMessageData, ThrowOnError>) => import("./client").RequestResult<CreateMessageResponses, unknown, ThrowOnError, "fields">;
|
|
123
|
-
/**
|
|
124
|
-
* Validate channel
|
|
125
|
-
* Asynchronously validate an SMTP channel (this endpoint is irrelevant to other channel types). When you create an SMTP channel via the API, [create a channel](https://dev.frontapp.com/reference/post_inboxes-inbox-id-channels) with type smtp and the send_as set to the needed email address. You then [configure the email provider](https://help.front.com/en/articles/2081), after which you use this endpoint to asynchronously validate the SMTP settings.
|
|
126
|
-
*/
|
|
127
|
-
export declare const validateChannel: <ThrowOnError extends boolean = false>(options: Options<ValidateChannelData, ThrowOnError>) => import("./client").RequestResult<ValidateChannelResponses, unknown, ThrowOnError, "fields">;
|
|
128
|
-
/**
|
|
129
|
-
* Get comment
|
|
130
|
-
* Fetches a comment.
|
|
131
|
-
*/
|
|
132
|
-
export declare const getComment: <ThrowOnError extends boolean = false>(options: Options<GetCommentData, ThrowOnError>) => import("./client").RequestResult<GetCommentResponses, unknown, ThrowOnError, "fields">;
|
|
133
|
-
/**
|
|
134
|
-
* Update comment
|
|
135
|
-
* Update a comment in a [conversation](https://dev.frontapp.com/reference/conversations).
|
|
136
|
-
*/
|
|
137
|
-
export declare const updateComment: <ThrowOnError extends boolean = false>(options: Options<UpdateCommentData, ThrowOnError>) => import("./client").RequestResult<UpdateCommentResponses, unknown, ThrowOnError, "fields">;
|
|
138
|
-
/**
|
|
139
|
-
* Download attachment for a comment
|
|
140
|
-
* Download an attachment file for a given comment ID
|
|
141
|
-
*/
|
|
142
|
-
export declare const downloadAttachmentForAComment: <ThrowOnError extends boolean = false>(options: Options<DownloadAttachmentForACommentData, ThrowOnError>) => import("./client").RequestResult<DownloadAttachmentForACommentResponses, unknown, ThrowOnError, "fields">;
|
|
143
|
-
/**
|
|
144
|
-
* List comment mentions
|
|
145
|
-
* List the teammates mentioned in a comment.
|
|
146
|
-
*/
|
|
147
|
-
export declare const listCommentMentions: <ThrowOnError extends boolean = false>(options: Options<ListCommentMentionsData, ThrowOnError>) => import("./client").RequestResult<ListCommentMentionsResponses, unknown, ThrowOnError, "fields">;
|
|
148
|
-
/**
|
|
149
|
-
* Add comment reply
|
|
150
|
-
* Add a reply to a comment on a [conversation](https://dev.frontapp.com/reference/conversations). Comment replies visually indicate which comment is being responded to, helping users follow the conversation.
|
|
151
|
-
*/
|
|
152
|
-
export declare const addCommentReply: <ThrowOnError extends boolean = false>(options: Options<AddCommentReplyData, ThrowOnError>) => import("./client").RequestResult<AddCommentReplyResponses, unknown, ThrowOnError, "fields">;
|
|
153
|
-
/**
|
|
154
|
-
* List all company rules
|
|
155
|
-
* List the company rules.
|
|
156
|
-
*/
|
|
157
|
-
export declare const listAllCompanyRules: <ThrowOnError extends boolean = false>(options?: Options<ListAllCompanyRulesData, ThrowOnError>) => import("./client").RequestResult<ListAllCompanyRulesResponses, unknown, ThrowOnError, "fields">;
|
|
158
|
-
/**
|
|
159
|
-
* List company ticket statuses
|
|
160
|
-
* List the ticket statuses available for your company.
|
|
161
|
-
*/
|
|
162
|
-
export declare const listCompanyTicketStatuses: <ThrowOnError extends boolean = false>(options?: Options<ListCompanyTicketStatusesData, ThrowOnError>) => import("./client").RequestResult<ListCompanyTicketStatusesResponses, ListCompanyTicketStatusesErrors, ThrowOnError, "fields">;
|
|
163
|
-
/**
|
|
164
|
-
* Get ticket status
|
|
165
|
-
* Fetch a ticket status.
|
|
166
|
-
*/
|
|
167
|
-
export declare const getTicketStatusById: <ThrowOnError extends boolean = false>(options: Options<GetTicketStatusByIdData, ThrowOnError>) => import("./client").RequestResult<GetTicketStatusByIdResponses, unknown, ThrowOnError, "fields">;
|
|
168
|
-
/**
|
|
169
|
-
* List company tags
|
|
170
|
-
* List the company tags.
|
|
171
|
-
*/
|
|
172
|
-
export declare const listCompanyTags: <ThrowOnError extends boolean = false>(options?: Options<ListCompanyTagsData, ThrowOnError>) => import("./client").RequestResult<ListCompanyTagsResponses, unknown, ThrowOnError, "fields">;
|
|
173
|
-
/**
|
|
174
|
-
* Create company tag
|
|
175
|
-
* Create a company tag.
|
|
176
|
-
*/
|
|
177
|
-
export declare const createCompanyTag: <ThrowOnError extends boolean = false>(options?: Options<CreateCompanyTagData, ThrowOnError>) => import("./client").RequestResult<CreateCompanyTagResponses, unknown, ThrowOnError, "fields">;
|
|
178
|
-
/**
|
|
179
|
-
* List groups
|
|
180
|
-
* List the contact groups.
|
|
181
|
-
*
|
|
182
|
-
* > ⚠️ Deprecated endpoint
|
|
183
|
-
* >
|
|
184
|
-
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
185
|
-
* > - `GET /contact_lists`.
|
|
186
|
-
*
|
|
187
|
-
* @deprecated
|
|
188
|
-
*/
|
|
189
|
-
export declare const listGroups: <ThrowOnError extends boolean = false>(options?: Options<ListGroupsData, ThrowOnError>) => import("./client").RequestResult<ListGroupsResponses, unknown, ThrowOnError, "fields">;
|
|
190
|
-
/**
|
|
191
|
-
* Create group
|
|
192
|
-
* Create a new contact group in the default team (workspace).
|
|
193
|
-
*
|
|
194
|
-
* > ⚠️ Deprecated endpoint
|
|
195
|
-
* >
|
|
196
|
-
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
197
|
-
* > - `POST /contact_lists`.
|
|
198
|
-
*
|
|
199
|
-
* @deprecated
|
|
200
|
-
*/
|
|
201
|
-
export declare const createGroup: <ThrowOnError extends boolean = false>(options?: Options<CreateGroupData, ThrowOnError>) => import("./client").RequestResult<CreateGroupResponses, unknown, ThrowOnError, "fields">;
|
|
202
|
-
/**
|
|
203
|
-
* Delete group
|
|
204
|
-
* Delete a contact group.
|
|
205
|
-
*
|
|
206
|
-
* > ⚠️ Deprecated endpoint
|
|
207
|
-
* >
|
|
208
|
-
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
209
|
-
* > - `DELETE /contact_lists/{contact_list_id}`.
|
|
210
|
-
*
|
|
211
|
-
* @deprecated
|
|
212
|
-
*/
|
|
213
|
-
export declare const deleteGroup: <ThrowOnError extends boolean = false>(options: Options<DeleteGroupData, ThrowOnError>) => import("./client").RequestResult<DeleteGroupResponses, unknown, ThrowOnError, "fields">;
|
|
214
|
-
/**
|
|
215
|
-
* Remove contacts from group
|
|
216
|
-
* Remove contacts from the requested group.
|
|
217
|
-
*
|
|
218
|
-
* > ⚠️ Deprecated endpoint
|
|
219
|
-
* >
|
|
220
|
-
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
221
|
-
* > - `DELETE /contact_lists/{contact_list_id}/contacts`.
|
|
222
|
-
*
|
|
223
|
-
*/
|
|
224
|
-
export declare const removeContactsFromGroup: <ThrowOnError extends boolean = false>(options: Options<RemoveContactsFromGroupData, ThrowOnError>) => import("./client").RequestResult<RemoveContactsFromGroupResponses, unknown, ThrowOnError, "fields">;
|
|
225
|
-
/**
|
|
226
|
-
* List contacts in group
|
|
227
|
-
* List the contacts belonging to the requested group.
|
|
228
|
-
*
|
|
229
|
-
* > ⚠️ Deprecated endpoint
|
|
230
|
-
* >
|
|
231
|
-
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
232
|
-
* > - `GET /contact_lists/{contact_list_id}/contacts`.
|
|
233
|
-
*
|
|
234
|
-
* @deprecated
|
|
235
|
-
*/
|
|
236
|
-
export declare const listContactsInGroup: <ThrowOnError extends boolean = false>(options: Options<ListContactsInGroupData, ThrowOnError>) => import("./client").RequestResult<ListContactsInGroupResponses, unknown, ThrowOnError, "fields">;
|
|
237
|
-
/**
|
|
238
|
-
* Add contacts to group
|
|
239
|
-
* Add contacts to the requested group.
|
|
240
|
-
*
|
|
241
|
-
* > ⚠️ Deprecated endpoint
|
|
242
|
-
* >
|
|
243
|
-
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
244
|
-
* > - `POST /contact_lists/{contact_list_id}/contacts`.
|
|
245
|
-
*
|
|
246
|
-
* @deprecated
|
|
247
|
-
*/
|
|
248
|
-
export declare const addContactsToGroup: <ThrowOnError extends boolean = false>(options: Options<AddContactsToGroupData, ThrowOnError>) => import("./client").RequestResult<AddContactsToGroupResponses, unknown, ThrowOnError, "fields">;
|
|
249
|
-
/**
|
|
250
|
-
* List contact lists
|
|
251
|
-
* List contact lists.
|
|
252
|
-
*/
|
|
253
|
-
export declare const listContactLists: <ThrowOnError extends boolean = false>(options?: Options<ListContactListsData, ThrowOnError>) => import("./client").RequestResult<ListContactListsResponses, unknown, ThrowOnError, "fields">;
|
|
254
|
-
/**
|
|
255
|
-
* Create contact list
|
|
256
|
-
* Create a new contact list in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team contact list](https://dev.frontapp.com/reference/create-team-contact-list) endpoint instead.
|
|
257
|
-
*/
|
|
258
|
-
export declare const createContactList: <ThrowOnError extends boolean = false>(options?: Options<CreateContactListData, ThrowOnError>) => import("./client").RequestResult<CreateContactListResponses, unknown, ThrowOnError, "fields">;
|
|
259
|
-
/**
|
|
260
|
-
* Delete contact list
|
|
261
|
-
* Delete a contact lists.
|
|
262
|
-
*/
|
|
263
|
-
export declare const deleteContactList: <ThrowOnError extends boolean = false>(options: Options<DeleteContactListData, ThrowOnError>) => import("./client").RequestResult<DeleteContactListResponses, unknown, ThrowOnError, "fields">;
|
|
264
|
-
/**
|
|
265
|
-
* Remove contacts from contact list
|
|
266
|
-
* Remove contacts from the requested contact list.
|
|
267
|
-
*/
|
|
268
|
-
export declare const removeContactsFromContactList: <ThrowOnError extends boolean = false>(options: Options<RemoveContactsFromContactListData, ThrowOnError>) => import("./client").RequestResult<RemoveContactsFromContactListResponses, unknown, ThrowOnError, "fields">;
|
|
269
|
-
/**
|
|
270
|
-
* List contacts in contact list
|
|
271
|
-
* List the contacts belonging to the requested contact list.
|
|
272
|
-
*/
|
|
273
|
-
export declare const listContactsInContactList: <ThrowOnError extends boolean = false>(options: Options<ListContactsInContactListData, ThrowOnError>) => import("./client").RequestResult<ListContactsInContactListResponses, unknown, ThrowOnError, "fields">;
|
|
274
|
-
/**
|
|
275
|
-
* Add contacts to contact list
|
|
276
|
-
* Add contacts to the requested contact list.
|
|
277
|
-
*/
|
|
278
|
-
export declare const addContactsToContactList: <ThrowOnError extends boolean = false>(options: Options<AddContactsToContactListData, ThrowOnError>) => import("./client").RequestResult<AddContactsToContactListResponses, unknown, ThrowOnError, "fields">;
|
|
279
|
-
/**
|
|
280
|
-
* List contacts
|
|
281
|
-
* List the contacts of the company.
|
|
282
|
-
*/
|
|
283
|
-
export declare const listContacts: <ThrowOnError extends boolean = false>(options?: Options<ListContactsData, ThrowOnError>) => import("./client").RequestResult<ListContactsResponses, unknown, ThrowOnError, "fields">;
|
|
284
|
-
/**
|
|
285
|
-
* Create contact
|
|
286
|
-
* Create a new contact at the company level.
|
|
287
|
-
*/
|
|
288
|
-
export declare const createContact: <ThrowOnError extends boolean = false>(options?: Options<CreateContactData, ThrowOnError>) => import("./client").RequestResult<CreateContactResponses, unknown, ThrowOnError, "fields">;
|
|
289
|
-
/**
|
|
290
|
-
* List Contact's custom fields
|
|
291
|
-
* Lists the custom fields that can be attached to a Contact.
|
|
292
|
-
*/
|
|
293
|
-
export declare const listContactCustomFields: <ThrowOnError extends boolean = false>(options?: Options<ListContactCustomFieldsData, ThrowOnError>) => import("./client").RequestResult<ListContactCustomFieldsResponses, unknown, ThrowOnError, "fields">;
|
|
294
|
-
/**
|
|
295
|
-
* Merge contacts
|
|
296
|
-
* Merges the contacts specified into a single contact, deleting the merged-in contacts.
|
|
297
|
-
* If a target contact ID is supplied, the other contacts will be merged into that one.
|
|
298
|
-
* Otherwise, some contact in the contact ID list will be treated as the target contact.
|
|
299
|
-
* Merge conflicts will be resolved in the following ways:
|
|
300
|
-
* * name will prioritize manually-updated and non-private contact names
|
|
301
|
-
* * descriptions will be concatenated and separated by newlines in order from
|
|
302
|
-
* oldest to newest with the (optional) target contact's description first
|
|
303
|
-
* * all handles, groups, links, and notes will be preserved
|
|
304
|
-
* * other conflicts will use the most recently updated contact's value
|
|
305
|
-
*
|
|
306
|
-
*/
|
|
307
|
-
export declare const mergeContacts: <ThrowOnError extends boolean = false>(options?: Options<MergeContactsData, ThrowOnError>) => import("./client").RequestResult<MergeContactsResponses, unknown, ThrowOnError, "fields">;
|
|
308
|
-
/**
|
|
309
|
-
* Delete a contact
|
|
310
|
-
* Delete a contact.
|
|
311
|
-
*/
|
|
312
|
-
export declare const deleteAContact: <ThrowOnError extends boolean = false>(options: Options<DeleteAContactData, ThrowOnError>) => import("./client").RequestResult<DeleteAContactResponses, unknown, ThrowOnError, "fields">;
|
|
313
|
-
/**
|
|
314
|
-
* Get contact
|
|
315
|
-
* Fetch a contact.
|
|
316
|
-
*/
|
|
317
|
-
export declare const getContact: <ThrowOnError extends boolean = false>(options: Options<GetContactData, ThrowOnError>) => import("./client").RequestResult<GetContactResponses, unknown, ThrowOnError, "fields">;
|
|
318
|
-
/**
|
|
319
|
-
* Update a contact
|
|
320
|
-
* Updates a contact.
|
|
321
|
-
*/
|
|
322
|
-
export declare const updateAContact: <ThrowOnError extends boolean = false>(options: Options<UpdateAContactData, ThrowOnError>) => import("./client").RequestResult<UpdateAContactResponses, unknown, ThrowOnError, "fields">;
|
|
323
|
-
/**
|
|
324
|
-
* List contact conversations
|
|
325
|
-
* List the conversations for a contact in reverse chronological order (newest first). For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
|
|
326
|
-
*
|
|
327
|
-
*/
|
|
328
|
-
export declare const listContactConversations: <ThrowOnError extends boolean = false>(options: Options<ListContactConversationsData, ThrowOnError>) => import("./client").RequestResult<ListContactConversationsResponses, unknown, ThrowOnError, "fields">;
|
|
329
|
-
/**
|
|
330
|
-
* Delete contact handle
|
|
331
|
-
* Remove a handle from a contact.
|
|
332
|
-
*/
|
|
333
|
-
export declare const deleteContactHandle: <ThrowOnError extends boolean = false>(options: Options<DeleteContactHandleData, ThrowOnError>) => import("./client").RequestResult<DeleteContactHandleResponses, unknown, ThrowOnError, "fields">;
|
|
334
|
-
/**
|
|
335
|
-
* Add contact handle
|
|
336
|
-
* Adds a new handle to a contact.
|
|
337
|
-
*/
|
|
338
|
-
export declare const addContactHandle: <ThrowOnError extends boolean = false>(options: Options<AddContactHandleData, ThrowOnError>) => import("./client").RequestResult<AddContactHandleResponses, unknown, ThrowOnError, "fields">;
|
|
339
|
-
/**
|
|
340
|
-
* List notes
|
|
341
|
-
* List the notes added to a contact.
|
|
342
|
-
*/
|
|
343
|
-
export declare const listNotes: <ThrowOnError extends boolean = false>(options: Options<ListNotesData, ThrowOnError>) => import("./client").RequestResult<ListNotesResponses, unknown, ThrowOnError, "fields">;
|
|
344
|
-
/**
|
|
345
|
-
* Add note
|
|
346
|
-
* Create a new note on a contact.
|
|
347
|
-
*/
|
|
348
|
-
export declare const addNote: <ThrowOnError extends boolean = false>(options: Options<AddNoteData, ThrowOnError>) => import("./client").RequestResult<AddNoteResponses, unknown, ThrowOnError, "fields">;
|
|
349
|
-
/**
|
|
350
|
-
* List conversations
|
|
351
|
-
* List the conversations in the company in reverse chronological order (most recently updated first). The order will respect your company's [bump settings](https://help.front.com/t/y729th/customize-when-conversations-bump-up), which determine when conversations bump to the top. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
|
|
352
|
-
*
|
|
353
|
-
*/
|
|
354
|
-
export declare const listConversations: <ThrowOnError extends boolean = false>(options?: Options<ListConversationsData, ThrowOnError>) => import("./client").RequestResult<ListConversationsResponses, unknown, ThrowOnError, "fields">;
|
|
355
|
-
/**
|
|
356
|
-
* Create discussion conversation
|
|
357
|
-
* Create a new [conversation](https://dev.frontapp.com/reference/conversations#creating-a-new-conversation) that only supports comments (known as discussions in Front). If you want to create a conversation that supports messages, use the [Create message](https://dev.frontapp.com/reference/post_channels-channel-id-messages) endpoint. If you want to add a comment to an existing conversation, use the [Add comment](https://dev.frontapp.com/reference/post_conversations-conversation-id-comments) endpoint.
|
|
358
|
-
*/
|
|
359
|
-
export declare const createConversation: <ThrowOnError extends boolean = false>(options?: Options<CreateConversationData, ThrowOnError>) => import("./client").RequestResult<CreateConversationResponses, unknown, ThrowOnError, "fields">;
|
|
360
|
-
/**
|
|
361
|
-
* List Conversation's custom fields
|
|
362
|
-
* Lists the custom fields that can be attached to a Conversation.
|
|
363
|
-
*/
|
|
364
|
-
export declare const listConversationCustomFields: <ThrowOnError extends boolean = false>(options?: Options<ListConversationCustomFieldsData, ThrowOnError>) => import("./client").RequestResult<ListConversationCustomFieldsResponses, unknown, ThrowOnError, "fields">;
|
|
365
|
-
/**
|
|
366
|
-
* Search conversations
|
|
367
|
-
* Search for conversations. Response will include a count of total matches and an array of conversations in descending order by last activity.
|
|
368
|
-
* See the [search syntax documentation](https://dev.frontapp.com/docs/search-1) for usage examples.
|
|
369
|
-
* **Note:** This endpoint is subject to [proportional rate limiting](https://dev.frontapp.com/docs/rate-limiting#additional-proportional-limiting) at 40% of your company's rate limit.
|
|
370
|
-
*
|
|
371
|
-
*/
|
|
372
|
-
export declare const searchConversations: <ThrowOnError extends boolean = false>(options: Options<SearchConversationsData, ThrowOnError>) => import("./client").RequestResult<SearchConversationsResponses, unknown, ThrowOnError, "fields">;
|
|
373
|
-
/**
|
|
374
|
-
* Get conversation
|
|
375
|
-
* Fetch a conversation.
|
|
376
|
-
*
|
|
377
|
-
*/
|
|
378
|
-
export declare const getConversationById: <ThrowOnError extends boolean = false>(options: Options<GetConversationByIdData, ThrowOnError>) => import("./client").RequestResult<GetConversationByIdResponses, unknown, ThrowOnError, "fields">;
|
|
379
|
-
/**
|
|
380
|
-
* Update conversation
|
|
381
|
-
* Update a conversation.
|
|
382
|
-
*/
|
|
383
|
-
export declare const updateConversation: <ThrowOnError extends boolean = false>(options: Options<UpdateConversationData, ThrowOnError>) => import("./client").RequestResult<UpdateConversationResponses, UpdateConversationErrors, ThrowOnError, "fields">;
|
|
384
|
-
/**
|
|
385
|
-
* Update conversation assignee
|
|
386
|
-
* Assign or unassign a conversation.
|
|
387
|
-
*/
|
|
388
|
-
export declare const updateConversationAssignee: <ThrowOnError extends boolean = false>(options: Options<UpdateConversationAssigneeData, ThrowOnError>) => import("./client").RequestResult<UpdateConversationAssigneeResponses, unknown, ThrowOnError, "fields">;
|
|
389
|
-
/**
|
|
390
|
-
* List conversation comments
|
|
391
|
-
* List the comments in a conversation in reverse chronological order (newest first).
|
|
392
|
-
*/
|
|
393
|
-
export declare const listConversationComments: <ThrowOnError extends boolean = false>(options: Options<ListConversationCommentsData, ThrowOnError>) => import("./client").RequestResult<ListConversationCommentsResponses, unknown, ThrowOnError, "fields">;
|
|
394
|
-
/**
|
|
395
|
-
* Add comment
|
|
396
|
-
* Add a comment to a [conversation](https://dev.frontapp.com/reference/conversations). If you want to create a new comment-only conversation, use the [Create discussion conversation](https://dev.frontapp.com/reference/create-conversation) endpoint.
|
|
397
|
-
*/
|
|
398
|
-
export declare const addComment: <ThrowOnError extends boolean = false>(options: Options<AddCommentData, ThrowOnError>) => import("./client").RequestResult<AddCommentResponses, unknown, ThrowOnError, "fields">;
|
|
399
|
-
/**
|
|
400
|
-
* List conversation drafts
|
|
401
|
-
* List the drafts in a conversation.
|
|
402
|
-
*/
|
|
403
|
-
export declare const listConversationDrafts: <ThrowOnError extends boolean = false>(options: Options<ListConversationDraftsData, ThrowOnError>) => import("./client").RequestResult<ListConversationDraftsResponses, unknown, ThrowOnError, "fields">;
|
|
404
|
-
/**
|
|
405
|
-
* Create draft reply
|
|
406
|
-
* Create a new draft as a reply to the last message in the conversation.
|
|
407
|
-
*/
|
|
408
|
-
export declare const createDraftReply: <ThrowOnError extends boolean = false>(options: Options<CreateDraftReplyData, ThrowOnError>) => import("./client").RequestResult<CreateDraftReplyResponses, unknown, ThrowOnError, "fields">;
|
|
409
|
-
/**
|
|
410
|
-
* List conversation events
|
|
411
|
-
* List the events that occured for a conversation in reverse chronological order (newest first). The order will respect your company's [bump settings](https://help.front.com/t/y729th/customize-when-conversations-bump-up), which determine when conversations bump to the top.
|
|
412
|
-
*/
|
|
413
|
-
export declare const listConversationEvents: <ThrowOnError extends boolean = false>(options: Options<ListConversationEventsData, ThrowOnError>) => import("./client").RequestResult<ListConversationEventsResponses, unknown, ThrowOnError, "fields">;
|
|
414
|
-
/**
|
|
415
|
-
* Delete conversation followers
|
|
416
|
-
* Removes teammates from the list of followers of a conversation.
|
|
417
|
-
*/
|
|
418
|
-
export declare const deleteConversationFollowers: <ThrowOnError extends boolean = false>(options: Options<DeleteConversationFollowersData, ThrowOnError>) => import("./client").RequestResult<DeleteConversationFollowersResponses, unknown, ThrowOnError, "fields">;
|
|
419
|
-
/**
|
|
420
|
-
* List conversation followers
|
|
421
|
-
* List the teammates following a conversation.
|
|
422
|
-
*/
|
|
423
|
-
export declare const listConversationFollowers: <ThrowOnError extends boolean = false>(options: Options<ListConversationFollowersData, ThrowOnError>) => import("./client").RequestResult<ListConversationFollowersResponses, unknown, ThrowOnError, "fields">;
|
|
424
|
-
/**
|
|
425
|
-
* Add conversation followers
|
|
426
|
-
* Adds teammates to the list of followers of a conversation.
|
|
427
|
-
*/
|
|
428
|
-
export declare const addConversationFollowers: <ThrowOnError extends boolean = false>(options: Options<AddConversationFollowersData, ThrowOnError>) => import("./client").RequestResult<AddConversationFollowersResponses, unknown, ThrowOnError, "fields">;
|
|
429
|
-
/**
|
|
430
|
-
* List conversation inboxes
|
|
431
|
-
* List the inboxes in which a conversation is listed.
|
|
432
|
-
*/
|
|
433
|
-
export declare const listConversationInboxes: <ThrowOnError extends boolean = false>(options: Options<ListConversationInboxesData, ThrowOnError>) => import("./client").RequestResult<ListConversationInboxesResponses, unknown, ThrowOnError, "fields">;
|
|
434
|
-
/**
|
|
435
|
-
* Remove conversation links
|
|
436
|
-
* Removes one or more links to a conversation.
|
|
437
|
-
* For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
438
|
-
*
|
|
439
|
-
*/
|
|
440
|
-
export declare const removeConversationLinks: <ThrowOnError extends boolean = false>(options: Options<RemoveConversationLinksData, ThrowOnError>) => import("./client").RequestResult<RemoveConversationLinksResponses, unknown, ThrowOnError, "fields">;
|
|
441
|
-
/**
|
|
442
|
-
* Add conversation link
|
|
443
|
-
* Adds one or more links to a conversation
|
|
444
|
-
* For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
445
|
-
*
|
|
446
|
-
*/
|
|
447
|
-
export declare const addConversationLink: <ThrowOnError extends boolean = false>(options: Options<AddConversationLinkData, ThrowOnError>) => import("./client").RequestResult<AddConversationLinkResponses, unknown, ThrowOnError, "fields">;
|
|
448
|
-
/**
|
|
449
|
-
* List conversation messages
|
|
450
|
-
* List the messages in a conversation in reverse chronological order (newest first).
|
|
451
|
-
*/
|
|
452
|
-
export declare const listConversationMessages: <ThrowOnError extends boolean = false>(options: Options<ListConversationMessagesData, ThrowOnError>) => import("./client").RequestResult<ListConversationMessagesResponses, unknown, ThrowOnError, "fields">;
|
|
453
|
-
/**
|
|
454
|
-
* Create message reply
|
|
455
|
-
* Reply to a conversation by sending a message and appending it to the conversation.
|
|
456
|
-
*/
|
|
457
|
-
export declare const createMessageReply: <ThrowOnError extends boolean = false>(options: Options<CreateMessageReplyData, ThrowOnError>) => import("./client").RequestResult<CreateMessageReplyResponses, unknown, ThrowOnError, "fields">;
|
|
458
|
-
/**
|
|
459
|
-
* Update conversation reminders
|
|
460
|
-
* Snooze or unsnooze a conversation for the provided user.
|
|
461
|
-
* For private conversations, reminders can only be created and edited through the API for teammates that own the conversation.
|
|
462
|
-
* For shared conversations, reminders created and edited through the API are shared for all teammates within the shared inbox(es) that the conversation belongs to.
|
|
463
|
-
*
|
|
464
|
-
*/
|
|
465
|
-
export declare const updateConversationReminders: <ThrowOnError extends boolean = false>(options: Options<UpdateConversationRemindersData, ThrowOnError>) => import("./client").RequestResult<UpdateConversationRemindersResponses, unknown, ThrowOnError, "fields">;
|
|
466
|
-
/**
|
|
467
|
-
* Remove conversation tag
|
|
468
|
-
* Removes one or more tags to a conversation
|
|
469
|
-
*/
|
|
470
|
-
export declare const removeConversationTag: <ThrowOnError extends boolean = false>(options: Options<RemoveConversationTagData, ThrowOnError>) => import("./client").RequestResult<RemoveConversationTagResponses, unknown, ThrowOnError, "fields">;
|
|
471
|
-
/**
|
|
472
|
-
* Add conversation tag
|
|
473
|
-
* Adds one or more tags to a conversation
|
|
474
|
-
*/
|
|
475
|
-
export declare const addConversationTag: <ThrowOnError extends boolean = false>(options: Options<AddConversationTagData, ThrowOnError>) => import("./client").RequestResult<AddConversationTagResponses, unknown, ThrowOnError, "fields">;
|
|
476
|
-
/**
|
|
477
|
-
* List Contact's custom fields
|
|
478
|
-
* Lists the custom fields that can be attached to a Contact.
|
|
479
|
-
*
|
|
480
|
-
* > ⚠️ Deprecated endpoint
|
|
481
|
-
* >
|
|
482
|
-
* > This endpoint has been deprecated. Please use the fully compatible `GET /contacts/custom_fields` endpoint instead.
|
|
483
|
-
*
|
|
484
|
-
* @deprecated
|
|
485
|
-
*/
|
|
486
|
-
export declare const listCustomFields: <ThrowOnError extends boolean = false>(options?: Options<ListCustomFieldsData, ThrowOnError>) => import("./client").RequestResult<ListCustomFieldsResponses, unknown, ThrowOnError, "fields">;
|
|
487
|
-
/**
|
|
488
|
-
* Download attachment
|
|
489
|
-
* Download an attachment file.
|
|
490
|
-
*/
|
|
491
|
-
export declare const downloadAttachment: <ThrowOnError extends boolean = false>(options: Options<DownloadAttachmentData, ThrowOnError>) => import("./client").RequestResult<DownloadAttachmentResponses, unknown, ThrowOnError, "fields">;
|
|
492
|
-
/**
|
|
493
|
-
* Delete draft
|
|
494
|
-
* Delete a draft message.
|
|
495
|
-
*/
|
|
496
|
-
export declare const deleteDraft: <ThrowOnError extends boolean = false>(options: Options<DeleteDraftData, ThrowOnError>) => import("./client").RequestResult<DeleteDraftResponses, unknown, ThrowOnError, "fields">;
|
|
497
|
-
/**
|
|
498
|
-
* Edit draft
|
|
499
|
-
* Edit a draft message.
|
|
500
|
-
*/
|
|
501
|
-
export declare const editDraft: <ThrowOnError extends boolean = false>(options: Options<EditDraftData, ThrowOnError>) => import("./client").RequestResult<EditDraftResponses, unknown, ThrowOnError, "fields">;
|
|
502
|
-
/**
|
|
503
|
-
* List events
|
|
504
|
-
* Lists all the detailed events which occurred in the inboxes of the company ordered in reverse chronological order (newest first).
|
|
505
|
-
* Refer to the [Events](https://dev.frontapp.com/reference/events) topic for more information, including sorting and filtering.
|
|
506
|
-
*
|
|
507
|
-
*/
|
|
508
|
-
export declare const listEvents: <ThrowOnError extends boolean = false>(options?: Options<ListEventsData, ThrowOnError>) => import("./client").RequestResult<ListEventsResponses, unknown, ThrowOnError, "fields">;
|
|
509
|
-
/**
|
|
510
|
-
* Get event
|
|
511
|
-
* Fetch an event.
|
|
512
|
-
* Refer to the [Events](https://dev.frontapp.com/reference/events) topic for more information, including sorting and filtering.
|
|
513
|
-
*
|
|
514
|
-
*/
|
|
515
|
-
export declare const getEvent: <ThrowOnError extends boolean = false>(options: Options<GetEventData, ThrowOnError>) => import("./client").RequestResult<GetEventResponses, unknown, ThrowOnError, "fields">;
|
|
516
|
-
/**
|
|
517
|
-
* List inboxes
|
|
518
|
-
* List the inboxes of the company.
|
|
519
|
-
*/
|
|
520
|
-
export declare const listInboxes: <ThrowOnError extends boolean = false>(options?: Options<ListInboxesData, ThrowOnError>) => import("./client").RequestResult<ListInboxesResponses, unknown, ThrowOnError, "fields">;
|
|
521
|
-
/**
|
|
522
|
-
* Create inbox
|
|
523
|
-
* Create an inbox in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team inbox](https://dev.frontapp.com/reference/create-team-inbox) endpoint instead.
|
|
524
|
-
*/
|
|
525
|
-
export declare const createInbox: <ThrowOnError extends boolean = false>(options?: Options<CreateInboxData, ThrowOnError>) => import("./client").RequestResult<CreateInboxResponses, unknown, ThrowOnError, "fields">;
|
|
526
|
-
/**
|
|
527
|
-
* List Inbox's custom fields
|
|
528
|
-
* Lists the custom fields that can be attached to an Inbox.
|
|
529
|
-
*/
|
|
530
|
-
export declare const listInboxCustomFields: <ThrowOnError extends boolean = false>(options?: Options<ListInboxCustomFieldsData, ThrowOnError>) => import("./client").RequestResult<ListInboxCustomFieldsResponses, unknown, ThrowOnError, "fields">;
|
|
531
|
-
/**
|
|
532
|
-
* Get inbox
|
|
533
|
-
* Fetch an inbox.
|
|
534
|
-
*/
|
|
535
|
-
export declare const getInbox: <ThrowOnError extends boolean = false>(options: Options<GetInboxData, ThrowOnError>) => import("./client").RequestResult<GetInboxResponses, unknown, ThrowOnError, "fields">;
|
|
536
|
-
/**
|
|
537
|
-
* List inbox channels
|
|
538
|
-
* List the channels in an inbox.
|
|
539
|
-
*/
|
|
540
|
-
export declare const listInboxChannels: <ThrowOnError extends boolean = false>(options: Options<ListInboxChannelsData, ThrowOnError>) => import("./client").RequestResult<ListInboxChannelsResponses, unknown, ThrowOnError, "fields">;
|
|
541
|
-
/**
|
|
542
|
-
* Create a channel
|
|
543
|
-
* Create a channel in an inbox.
|
|
544
|
-
*/
|
|
545
|
-
export declare const createAChannel: <ThrowOnError extends boolean = false>(options: Options<CreateAChannelData, ThrowOnError>) => import("./client").RequestResult<CreateAChannelResponses, unknown, ThrowOnError, "fields">;
|
|
546
|
-
/**
|
|
547
|
-
* List inbox conversations
|
|
548
|
-
* List the conversations in an inbox. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
|
|
549
|
-
*
|
|
550
|
-
*/
|
|
551
|
-
export declare const listInboxConversations: <ThrowOnError extends boolean = false>(options: Options<ListInboxConversationsData, ThrowOnError>) => import("./client").RequestResult<ListInboxConversationsResponses, unknown, ThrowOnError, "fields">;
|
|
552
|
-
/**
|
|
553
|
-
* Import message
|
|
554
|
-
* Import a new message in an inbox. **Only use this endpoint to import historical, non-active conversations**. Do not use it to create messages for new conversations.
|
|
555
|
-
*/
|
|
556
|
-
export declare const importInboxMessage: <ThrowOnError extends boolean = false>(options: Options<ImportInboxMessageData, ThrowOnError>) => import("./client").RequestResult<ImportInboxMessageResponses, unknown, ThrowOnError, "fields">;
|
|
557
|
-
/**
|
|
558
|
-
* Removes inbox access
|
|
559
|
-
* Remove access of one or more teammates from an inbox.
|
|
560
|
-
*/
|
|
561
|
-
export declare const removesInboxAccess: <ThrowOnError extends boolean = false>(options: Options<RemovesInboxAccessData, ThrowOnError>) => import("./client").RequestResult<RemovesInboxAccessResponses, unknown, ThrowOnError, "fields">;
|
|
562
|
-
/**
|
|
563
|
-
* List inbox access
|
|
564
|
-
* List the teammates with access to an inbox.
|
|
565
|
-
*/
|
|
566
|
-
export declare const listInboxAccess: <ThrowOnError extends boolean = false>(options: Options<ListInboxAccessData, ThrowOnError>) => import("./client").RequestResult<ListInboxAccessResponses, unknown, ThrowOnError, "fields">;
|
|
567
|
-
/**
|
|
568
|
-
* Add inbox access
|
|
569
|
-
* Give access to one or more teammates to an inbox.
|
|
570
|
-
*/
|
|
571
|
-
export declare const addInboxAccess: <ThrowOnError extends boolean = false>(options: Options<AddInboxAccessData, ThrowOnError>) => import("./client").RequestResult<AddInboxAccessResponses, unknown, ThrowOnError, "fields">;
|
|
572
|
-
/**
|
|
573
|
-
* Delete an article
|
|
574
|
-
* Deletes an article and all its content and translations.
|
|
575
|
-
*/
|
|
576
|
-
export declare const deleteAnArticle: <ThrowOnError extends boolean = false>(options: Options<DeleteAnArticleData, ThrowOnError>) => import("./client").RequestResult<DeleteAnArticleResponses, unknown, ThrowOnError, "fields">;
|
|
577
|
-
/**
|
|
578
|
-
* Get a knowledge base article
|
|
579
|
-
* Fetches a knowledge base article.
|
|
580
|
-
*/
|
|
581
|
-
export declare const getAKnowledgeBaseArticle: <ThrowOnError extends boolean = false>(options: Options<GetAKnowledgeBaseArticleData, ThrowOnError>) => import("./client").RequestResult<GetAKnowledgeBaseArticleResponses, unknown, ThrowOnError, "fields">;
|
|
582
|
-
/**
|
|
583
|
-
* Get knowledge base article with content in default locale
|
|
584
|
-
* Fetches a knowledge base article with content in the default locale.
|
|
585
|
-
*/
|
|
586
|
-
export declare const getKnowledgeBaseArticleWithContentInDefaultLocale: <ThrowOnError extends boolean = false>(options: Options<GetKnowledgeBaseArticleWithContentInDefaultLocaleData, ThrowOnError>) => import("./client").RequestResult<GetKnowledgeBaseArticleWithContentInDefaultLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
587
|
-
/**
|
|
588
|
-
* Update article content in default locale.
|
|
589
|
-
* Updates an article's content in the default locale
|
|
590
|
-
*/
|
|
591
|
-
export declare const updateArticleContentInDefaultLocale: <ThrowOnError extends boolean = false>(options: Options<UpdateArticleContentInDefaultLocaleData, ThrowOnError>) => import("./client").RequestResult<UpdateArticleContentInDefaultLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
592
|
-
/**
|
|
593
|
-
* Download attachment from an article
|
|
594
|
-
* Downloads the attachment from an article.
|
|
595
|
-
*/
|
|
596
|
-
export declare const downloadAttachmentFromAnArticle: <ThrowOnError extends boolean = false>(options: Options<DownloadAttachmentFromAnArticleData, ThrowOnError>) => import("./client").RequestResult<DownloadAttachmentFromAnArticleResponses, unknown, ThrowOnError, "fields">;
|
|
597
|
-
/**
|
|
598
|
-
* Get knowledge base article with content in specified locale
|
|
599
|
-
* Fetches a knowledge base article with content for a given locale.
|
|
600
|
-
*/
|
|
601
|
-
export declare const getKnowledgeBaseArticleWithContentInSpecifiedLocale: <ThrowOnError extends boolean = false>(options: Options<GetKnowledgeBaseArticleWithContentInSpecifiedLocaleData, ThrowOnError>) => import("./client").RequestResult<GetKnowledgeBaseArticleWithContentInSpecifiedLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
602
|
-
/**
|
|
603
|
-
* Update article content in specified locale
|
|
604
|
-
* Updates an article's content for a given locale.
|
|
605
|
-
*/
|
|
606
|
-
export declare const updateArticleContentInSpecifiedLocale: <ThrowOnError extends boolean = false>(options: Options<UpdateArticleContentInSpecifiedLocaleData, ThrowOnError>) => import("./client").RequestResult<UpdateArticleContentInSpecifiedLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
607
|
-
/**
|
|
608
|
-
* Delete a knowledge base category
|
|
609
|
-
* Deletes a knowledge base category.
|
|
610
|
-
*
|
|
611
|
-
* > ⚠️ Warning
|
|
612
|
-
* >
|
|
613
|
-
* > When a category is deleted, all articles in the category are also deleted.
|
|
614
|
-
*
|
|
615
|
-
*/
|
|
616
|
-
export declare const deleteAKnowledgeBaseCategory: <ThrowOnError extends boolean = false>(options: Options<DeleteAKnowledgeBaseCategoryData, ThrowOnError>) => import("./client").RequestResult<DeleteAKnowledgeBaseCategoryResponses, unknown, ThrowOnError, "fields">;
|
|
617
|
-
/**
|
|
618
|
-
* Get a knowledge base category
|
|
619
|
-
* Fetches a knowledge base category.
|
|
620
|
-
*/
|
|
621
|
-
export declare const getAKnowledgeBaseCategory: <ThrowOnError extends boolean = false>(options: Options<GetAKnowledgeBaseCategoryData, ThrowOnError>) => import("./client").RequestResult<GetAKnowledgeBaseCategoryResponses, unknown, ThrowOnError, "fields">;
|
|
622
|
-
/**
|
|
623
|
-
* List articles in a category
|
|
624
|
-
* List articles in a category.
|
|
625
|
-
*/
|
|
626
|
-
export declare const listArticlesInACategory: <ThrowOnError extends boolean = false>(options: Options<ListArticlesInACategoryData, ThrowOnError>) => import("./client").RequestResult<ListArticlesInACategoryResponses, unknown, ThrowOnError, "fields">;
|
|
627
|
-
/**
|
|
628
|
-
* Get knowledge base category content in default locale
|
|
629
|
-
* Fetches a knowledge base category with content in the default locale.
|
|
630
|
-
*/
|
|
631
|
-
export declare const getKnowledgeBaseCategoryContentInDefaultLocale: <ThrowOnError extends boolean = false>(options: Options<GetKnowledgeBaseCategoryContentInDefaultLocaleData, ThrowOnError>) => import("./client").RequestResult<GetKnowledgeBaseCategoryContentInDefaultLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
632
|
-
/**
|
|
633
|
-
* Update knowledge base category in default locale
|
|
634
|
-
* Updates a knowledge base category in the default locale. Will republish the knowledge base if the knowledge base is currently published.
|
|
635
|
-
*/
|
|
636
|
-
export declare const updateKnowledgeBaseCategoryInDefaultLocale: <ThrowOnError extends boolean = false>(options: Options<UpdateKnowledgeBaseCategoryInDefaultLocaleData, ThrowOnError>) => import("./client").RequestResult<UpdateKnowledgeBaseCategoryInDefaultLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
637
|
-
/**
|
|
638
|
-
* Get knowledge base category with content in specified locale
|
|
639
|
-
* Fetches a knowledge base category with content for a given locale.
|
|
640
|
-
*/
|
|
641
|
-
export declare const getKnowledgeBaseCategoryWithContentInSpecifiedLocale: <ThrowOnError extends boolean = false>(options: Options<GetKnowledgeBaseCategoryWithContentInSpecifiedLocaleData, ThrowOnError>) => import("./client").RequestResult<GetKnowledgeBaseCategoryWithContentInSpecifiedLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
642
|
-
/**
|
|
643
|
-
* Update knowledge base category in specified locale
|
|
644
|
-
* Updates a knowledge base category for a given locale. Will republish the knowledge base if the knowledge base is currently published.
|
|
645
|
-
*/
|
|
646
|
-
export declare const updateKnowledgeBaseCategoryInSpecifiedLocale: <ThrowOnError extends boolean = false>(options: Options<UpdateKnowledgeBaseCategoryInSpecifiedLocaleData, ThrowOnError>) => import("./client").RequestResult<UpdateKnowledgeBaseCategoryInSpecifiedLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
647
|
-
/**
|
|
648
|
-
* List knowledge bases
|
|
649
|
-
* List the knowledge bases of the company.
|
|
650
|
-
*/
|
|
651
|
-
export declare const listKnowledgeBases: <ThrowOnError extends boolean = false>(options?: Options<ListKnowledgeBasesData, ThrowOnError>) => import("./client").RequestResult<ListKnowledgeBasesResponses, unknown, ThrowOnError, "fields">;
|
|
652
|
-
/**
|
|
653
|
-
* Create a knowledge base
|
|
654
|
-
* Creates a knowledge base.
|
|
655
|
-
*/
|
|
656
|
-
export declare const createAKnowledgeBase: <ThrowOnError extends boolean = false>(options?: Options<CreateAKnowledgeBaseData, ThrowOnError>) => import("./client").RequestResult<CreateAKnowledgeBaseResponses, unknown, ThrowOnError, "fields">;
|
|
657
|
-
/**
|
|
658
|
-
* Get a knowledge base
|
|
659
|
-
* Fetches a knowledge base.
|
|
660
|
-
*/
|
|
661
|
-
export declare const getAKnowledgeBase: <ThrowOnError extends boolean = false>(options: Options<GetAKnowledgeBaseData, ThrowOnError>) => import("./client").RequestResult<GetAKnowledgeBaseResponses, unknown, ThrowOnError, "fields">;
|
|
662
|
-
/**
|
|
663
|
-
* List articles in a knowledge base
|
|
664
|
-
* List articles in a knowledge base
|
|
665
|
-
*/
|
|
666
|
-
export declare const listArticlesInAKnowledgeBase: <ThrowOnError extends boolean = false>(options: Options<ListArticlesInAKnowledgeBaseData, ThrowOnError>) => import("./client").RequestResult<ListArticlesInAKnowledgeBaseResponses, unknown, ThrowOnError, "fields">;
|
|
667
|
-
/**
|
|
668
|
-
* Create article in a knowledge base in default locale
|
|
669
|
-
* Creates an article in a knowledge base in the default locale.
|
|
670
|
-
*/
|
|
671
|
-
export declare const createArticleInAKnowledgeBaseInDefaultLocale: <ThrowOnError extends boolean = false>(options: Options<CreateArticleInAKnowledgeBaseInDefaultLocaleData, ThrowOnError>) => import("./client").RequestResult<CreateArticleInAKnowledgeBaseInDefaultLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
672
|
-
/**
|
|
673
|
-
* List categories in a knowledge base
|
|
674
|
-
* List categories in a knowledge base.
|
|
675
|
-
*/
|
|
676
|
-
export declare const listCategoriesInAKnowledgeBase: <ThrowOnError extends boolean = false>(options: Options<ListCategoriesInAKnowledgeBaseData, ThrowOnError>) => import("./client").RequestResult<ListCategoriesInAKnowledgeBaseResponses, unknown, ThrowOnError, "fields">;
|
|
677
|
-
/**
|
|
678
|
-
* Create knowledge base category in default locale
|
|
679
|
-
* Creates a knowledge base category in the default locale.
|
|
680
|
-
*/
|
|
681
|
-
export declare const createKnowledgeBaseCategoryInDefaultLocale: <ThrowOnError extends boolean = false>(options: Options<CreateKnowledgeBaseCategoryInDefaultLocaleData, ThrowOnError>) => import("./client").RequestResult<CreateKnowledgeBaseCategoryInDefaultLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
682
|
-
/**
|
|
683
|
-
* Get a knowledge base with content in default locale
|
|
684
|
-
* Fetches a knowledge base with its content in the default locale.
|
|
685
|
-
*/
|
|
686
|
-
export declare const getAKnowledgeBaseWithContentInDefaultLocale: <ThrowOnError extends boolean = false>(options: Options<GetAKnowledgeBaseWithContentInDefaultLocaleData, ThrowOnError>) => import("./client").RequestResult<GetAKnowledgeBaseWithContentInDefaultLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
687
|
-
/**
|
|
688
|
-
* Update knowledge base in default locale
|
|
689
|
-
* Updates a knowledge base in the default locale. Will republish the knowledge base if the knowledge base is currently published.
|
|
690
|
-
*/
|
|
691
|
-
export declare const updateKnowledgeBaseInDefaultLocale: <ThrowOnError extends boolean = false>(options: Options<UpdateKnowledgeBaseInDefaultLocaleData, ThrowOnError>) => import("./client").RequestResult<UpdateKnowledgeBaseInDefaultLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
692
|
-
/**
|
|
693
|
-
* Create article in a knowledge base in specified locale
|
|
694
|
-
* Create an article for a given locale in a knowledge base.
|
|
695
|
-
*/
|
|
696
|
-
export declare const createArticleInAKnowledgeBaseInSpecifiedLocale: <ThrowOnError extends boolean = false>(options: Options<CreateArticleInAKnowledgeBaseInSpecifiedLocaleData, ThrowOnError>) => import("./client").RequestResult<CreateArticleInAKnowledgeBaseInSpecifiedLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
697
|
-
/**
|
|
698
|
-
* Create knowledge base category in specified locale
|
|
699
|
-
* Creates a knowledge base category for a given locale.
|
|
700
|
-
*/
|
|
701
|
-
export declare const createKnowledgeBaseCategoryInSpecifiedLocale: <ThrowOnError extends boolean = false>(options: Options<CreateKnowledgeBaseCategoryInSpecifiedLocaleData, ThrowOnError>) => import("./client").RequestResult<CreateKnowledgeBaseCategoryInSpecifiedLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
702
|
-
/**
|
|
703
|
-
* Get a knowledge base with content in specified locale
|
|
704
|
-
* Fetches a knowledge base with its content for a given locale.
|
|
705
|
-
*/
|
|
706
|
-
export declare const getAKnowledgeBaseWithContentInSpecifiedLocale: <ThrowOnError extends boolean = false>(options: Options<GetAKnowledgeBaseWithContentInSpecifiedLocaleData, ThrowOnError>) => import("./client").RequestResult<GetAKnowledgeBaseWithContentInSpecifiedLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
707
|
-
/**
|
|
708
|
-
* Update knowledge base in specified locale
|
|
709
|
-
* Updates a knowledge base for a given locale. Will republish the knowledge base if the knowledge base is currently published.
|
|
710
|
-
*/
|
|
711
|
-
export declare const updateKnowledgeBaseInSpecifiedLocale: <ThrowOnError extends boolean = false>(options: Options<UpdateKnowledgeBaseInSpecifiedLocaleData, ThrowOnError>) => import("./client").RequestResult<UpdateKnowledgeBaseInSpecifiedLocaleResponses, unknown, ThrowOnError, "fields">;
|
|
712
|
-
/**
|
|
713
|
-
* List links
|
|
714
|
-
* List the links of the company paginated by id. Allows filtering by link type via the q.types param.
|
|
715
|
-
* These links include application objects; for more details, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
716
|
-
*
|
|
717
|
-
*/
|
|
718
|
-
export declare const listLinks: <ThrowOnError extends boolean = false>(options?: Options<ListLinksData, ThrowOnError>) => import("./client").RequestResult<ListLinksResponses, unknown, ThrowOnError, "fields">;
|
|
719
|
-
/**
|
|
720
|
-
* Create link
|
|
721
|
-
* Create a link. You must supply either `pattern` or `external_url` in the request, but not both (`pattern` is for application objects while `external_url` is for standard links). If `pattern` is provided, the API call updates the application objects matching the exact pattern. Keep in mind this endpoint only creates or updates an existing link from an application object. It does not create new application objects. If the link is resolved to an installed links integration, any name retrieved from the integration will override the provided name in the request.
|
|
722
|
-
*/
|
|
723
|
-
export declare const createLink: <ThrowOnError extends boolean = false>(options?: Options<CreateLinkData, ThrowOnError>) => import("./client").RequestResult<CreateLinkResponses, unknown, ThrowOnError, "fields">;
|
|
724
|
-
/**
|
|
725
|
-
* List Link's custom fields
|
|
726
|
-
* Lists the custom fields that can be attached to a Link.
|
|
727
|
-
* For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
728
|
-
*
|
|
729
|
-
*/
|
|
730
|
-
export declare const listLinkCustomFields: <ThrowOnError extends boolean = false>(options?: Options<ListLinkCustomFieldsData, ThrowOnError>) => import("./client").RequestResult<ListLinkCustomFieldsResponses, unknown, ThrowOnError, "fields">;
|
|
731
|
-
/**
|
|
732
|
-
* Get link
|
|
733
|
-
* Fetch a link.
|
|
734
|
-
* For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
735
|
-
*
|
|
736
|
-
*/
|
|
737
|
-
export declare const getLink: <ThrowOnError extends boolean = false>(options: Options<GetLinkData, ThrowOnError>) => import("./client").RequestResult<GetLinkResponses, unknown, ThrowOnError, "fields">;
|
|
738
|
-
/**
|
|
739
|
-
* Update a link
|
|
740
|
-
* Update a link.
|
|
741
|
-
* For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
742
|
-
*
|
|
743
|
-
*/
|
|
744
|
-
export declare const updateALink: <ThrowOnError extends boolean = false>(options: Options<UpdateALinkData, ThrowOnError>) => import("./client").RequestResult<UpdateALinkResponses, unknown, ThrowOnError, "fields">;
|
|
745
|
-
/**
|
|
746
|
-
* List link conversations
|
|
747
|
-
* List the conversations linked to a specific link. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
|
|
748
|
-
* For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.
|
|
749
|
-
*
|
|
750
|
-
*/
|
|
751
|
-
export declare const listLinkConversations: <ThrowOnError extends boolean = false>(options: Options<ListLinkConversationsData, ThrowOnError>) => import("./client").RequestResult<ListLinkConversationsResponses, unknown, ThrowOnError, "fields">;
|
|
752
|
-
/**
|
|
753
|
-
* API Token details
|
|
754
|
-
* Fetch the details of the API token.
|
|
755
|
-
*/
|
|
756
|
-
export declare const apiTokenDetails: <ThrowOnError extends boolean = false>(options?: Options<ApiTokenDetailsData, ThrowOnError>) => import("./client").RequestResult<ApiTokenDetailsResponses, unknown, ThrowOnError, "fields">;
|
|
757
|
-
/**
|
|
758
|
-
* List folders
|
|
759
|
-
* List the message template folders.
|
|
760
|
-
*/
|
|
761
|
-
export declare const listFolders: <ThrowOnError extends boolean = false>(options?: Options<ListFoldersData, ThrowOnError>) => import("./client").RequestResult<ListFoldersResponses, unknown, ThrowOnError, "fields">;
|
|
762
|
-
/**
|
|
763
|
-
* Create folder
|
|
764
|
-
* Create a new message template folder in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team folder](https://dev.frontapp.com/reference/create-team-folder) endpoint instead.
|
|
765
|
-
*/
|
|
766
|
-
export declare const createFolder: <ThrowOnError extends boolean = false>(options?: Options<CreateFolderData, ThrowOnError>) => import("./client").RequestResult<CreateFolderResponses, unknown, ThrowOnError, "fields">;
|
|
767
|
-
/**
|
|
768
|
-
* Delete folder
|
|
769
|
-
* Delete a message template folder and child folders/templates
|
|
770
|
-
*/
|
|
771
|
-
export declare const deleteFolder: <ThrowOnError extends boolean = false>(options: Options<DeleteFolderData, ThrowOnError>) => import("./client").RequestResult<DeleteFolderResponses, unknown, ThrowOnError, "fields">;
|
|
772
|
-
/**
|
|
773
|
-
* Get folder
|
|
774
|
-
* Fetch a message template folder.
|
|
775
|
-
*/
|
|
776
|
-
export declare const getFolder: <ThrowOnError extends boolean = false>(options: Options<GetFolderData, ThrowOnError>) => import("./client").RequestResult<GetFolderResponses, unknown, ThrowOnError, "fields">;
|
|
777
|
-
/**
|
|
778
|
-
* Update folder
|
|
779
|
-
* Update message template folder
|
|
780
|
-
*/
|
|
781
|
-
export declare const updateFolder: <ThrowOnError extends boolean = false>(options: Options<UpdateFolderData, ThrowOnError>) => import("./client").RequestResult<UpdateFolderResponses, unknown, ThrowOnError, "fields">;
|
|
782
|
-
/**
|
|
783
|
-
* Get child folders
|
|
784
|
-
* Fetch the child message templates folders of a message template folder.
|
|
785
|
-
*/
|
|
786
|
-
export declare const getChildFolders: <ThrowOnError extends boolean = false>(options: Options<GetChildFoldersData, ThrowOnError>) => import("./client").RequestResult<GetChildFoldersResponses, unknown, ThrowOnError, "fields">;
|
|
787
|
-
/**
|
|
788
|
-
* Create child folder
|
|
789
|
-
* Create a new message template folder as a child of the given folder
|
|
790
|
-
*/
|
|
791
|
-
export declare const createChildFolder: <ThrowOnError extends boolean = false>(options: Options<CreateChildFolderData, ThrowOnError>) => import("./client").RequestResult<CreateChildFolderResponses, unknown, ThrowOnError, "fields">;
|
|
792
|
-
/**
|
|
793
|
-
* Get child templates
|
|
794
|
-
* Fetch the child message templates of a message template folder.
|
|
795
|
-
*/
|
|
796
|
-
export declare const getChildTemplates: <ThrowOnError extends boolean = false>(options: Options<GetChildTemplatesData, ThrowOnError>) => import("./client").RequestResult<GetChildTemplatesResponses, unknown, ThrowOnError, "fields">;
|
|
797
|
-
/**
|
|
798
|
-
* Create child template
|
|
799
|
-
* Create a new message template as a child of the given folder
|
|
800
|
-
*/
|
|
801
|
-
export declare const createChildTemplate: <ThrowOnError extends boolean = false>(options: Options<CreateChildTemplateData, ThrowOnError>) => import("./client").RequestResult<CreateChildTemplateResponses, unknown, ThrowOnError, "fields">;
|
|
802
|
-
/**
|
|
803
|
-
* List message templates
|
|
804
|
-
* List the message templates.
|
|
805
|
-
*/
|
|
806
|
-
export declare const listMessageTemplates: <ThrowOnError extends boolean = false>(options?: Options<ListMessageTemplatesData, ThrowOnError>) => import("./client").RequestResult<ListMessageTemplatesResponses, unknown, ThrowOnError, "fields">;
|
|
807
|
-
/**
|
|
808
|
-
* Create message template
|
|
809
|
-
* Create a new message template in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team message template](https://dev.frontapp.com/reference/create-team-message-template) endpoint instead.
|
|
810
|
-
*/
|
|
811
|
-
export declare const createMessageTemplate: <ThrowOnError extends boolean = false>(options?: Options<CreateMessageTemplateData, ThrowOnError>) => import("./client").RequestResult<CreateMessageTemplateResponses, unknown, ThrowOnError, "fields">;
|
|
812
|
-
/**
|
|
813
|
-
* Delete message template
|
|
814
|
-
* Delete a message template
|
|
815
|
-
*/
|
|
816
|
-
export declare const deleteMessageTemplate: <ThrowOnError extends boolean = false>(options: Options<DeleteMessageTemplateData, ThrowOnError>) => import("./client").RequestResult<DeleteMessageTemplateResponses, unknown, ThrowOnError, "fields">;
|
|
817
|
-
/**
|
|
818
|
-
* Get message template
|
|
819
|
-
* Fetch a message template.
|
|
820
|
-
*/
|
|
821
|
-
export declare const getMessageTemplate: <ThrowOnError extends boolean = false>(options: Options<GetMessageTemplateData, ThrowOnError>) => import("./client").RequestResult<GetMessageTemplateResponses, unknown, ThrowOnError, "fields">;
|
|
822
|
-
/**
|
|
823
|
-
* Update message template
|
|
824
|
-
* Update message template
|
|
825
|
-
*/
|
|
826
|
-
export declare const updateMessageTemplate: <ThrowOnError extends boolean = false>(options: Options<UpdateMessageTemplateData, ThrowOnError>) => import("./client").RequestResult<UpdateMessageTemplateResponses, unknown, ThrowOnError, "fields">;
|
|
827
|
-
/**
|
|
828
|
-
* Download attachment for a message template
|
|
829
|
-
* Download an attachment file for a given message template ID
|
|
830
|
-
*/
|
|
831
|
-
export declare const downloadAttachmentForAMessageTemplate: <ThrowOnError extends boolean = false>(options: Options<DownloadAttachmentForAMessageTemplateData, ThrowOnError>) => import("./client").RequestResult<DownloadAttachmentForAMessageTemplateResponses, unknown, ThrowOnError, "fields">;
|
|
832
|
-
/**
|
|
833
|
-
* Get message
|
|
834
|
-
* Fetch a message.
|
|
835
|
-
*
|
|
836
|
-
* > ℹ️ The HTTP Header `Accept` can be used to request the message in a different format.
|
|
837
|
-
* > By default, Front will return the documented JSON response. By requesting `message/rfc822`, the response will contain the message in the EML format (for email messages only).
|
|
838
|
-
*
|
|
839
|
-
*/
|
|
840
|
-
export declare const getMessage: <ThrowOnError extends boolean = false>(options: Options<GetMessageData, ThrowOnError>) => import("./client").RequestResult<GetMessageResponses, unknown, ThrowOnError, "fields">;
|
|
841
|
-
/**
|
|
842
|
-
* Download attachment for a message
|
|
843
|
-
* Download an attachment file for a given message id. Should be used by partner channels.
|
|
844
|
-
*/
|
|
845
|
-
export declare const downloadAttachmentForAMessage: <ThrowOnError extends boolean = false>(options: Options<DownloadAttachmentForAMessageData, ThrowOnError>) => import("./client").RequestResult<DownloadAttachmentForAMessageResponses, unknown, ThrowOnError, "fields">;
|
|
846
|
-
/**
|
|
847
|
-
* Get message seen status
|
|
848
|
-
* Get the seen receipts for the given message. If no seen-by information is available, there will be a single entry for the first time the message was seen by any recipient. If seen-by information is available, there will be an entry for each recipient who has seen the message.
|
|
849
|
-
*/
|
|
850
|
-
export declare const getMessageSeenStatus: <ThrowOnError extends boolean = false>(options: Options<GetMessageSeenStatusData, ThrowOnError>) => import("./client").RequestResult<GetMessageSeenStatusResponses, unknown, ThrowOnError, "fields">;
|
|
851
|
-
/**
|
|
852
|
-
* Mark message seen
|
|
853
|
-
* Mark an outbound message from Front as seen. Note, the message seen route should only be called in response to an actual end-user's message-seen action. In accordance with this behavior, the route is rate limited to 10 requests per message per hour.
|
|
854
|
-
*/
|
|
855
|
-
export declare const markMessageSeen: <ThrowOnError extends boolean = false>(options: Options<MarkMessageSeenData, ThrowOnError>) => import("./client").RequestResult<MarkMessageSeenResponses, unknown, ThrowOnError, "fields">;
|
|
856
|
-
/**
|
|
857
|
-
* List rules
|
|
858
|
-
* List the rules of the company.
|
|
859
|
-
*/
|
|
860
|
-
export declare const listRules: <ThrowOnError extends boolean = false>(options?: Options<ListRulesData, ThrowOnError>) => import("./client").RequestResult<ListRulesResponses, unknown, ThrowOnError, "fields">;
|
|
861
|
-
/**
|
|
862
|
-
* Get rule
|
|
863
|
-
* Fetch a rule.
|
|
864
|
-
*/
|
|
865
|
-
export declare const getRule: <ThrowOnError extends boolean = false>(options: Options<GetRuleData, ThrowOnError>) => import("./client").RequestResult<GetRuleResponses, unknown, ThrowOnError, "fields">;
|
|
866
|
-
/**
|
|
867
|
-
* List Shifts
|
|
868
|
-
* List the shifts.
|
|
869
|
-
*/
|
|
870
|
-
export declare const listShifts: <ThrowOnError extends boolean = false>(options?: Options<ListShiftsData, ThrowOnError>) => import("./client").RequestResult<ListShiftsResponses, unknown, ThrowOnError, "fields">;
|
|
871
|
-
/**
|
|
872
|
-
* Create shift
|
|
873
|
-
* Create a shift in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team shift](https://dev.frontapp.com/reference/create-team-shift) endpoint instead.
|
|
874
|
-
*/
|
|
875
|
-
export declare const createShift: <ThrowOnError extends boolean = false>(options?: Options<CreateShiftData, ThrowOnError>) => import("./client").RequestResult<CreateShiftResponses, unknown, ThrowOnError, "fields">;
|
|
876
|
-
/**
|
|
877
|
-
* Get shift
|
|
878
|
-
* Fetch a shift.
|
|
879
|
-
*/
|
|
880
|
-
export declare const getShift: <ThrowOnError extends boolean = false>(options: Options<GetShiftData, ThrowOnError>) => import("./client").RequestResult<GetShiftResponses, unknown, ThrowOnError, "fields">;
|
|
881
|
-
/**
|
|
882
|
-
* Update shift
|
|
883
|
-
* Update a shift.
|
|
884
|
-
*/
|
|
885
|
-
export declare const updateShift: <ThrowOnError extends boolean = false>(options: Options<UpdateShiftData, ThrowOnError>) => import("./client").RequestResult<UpdateShiftResponses, unknown, ThrowOnError, "fields">;
|
|
886
|
-
/**
|
|
887
|
-
* Remove teammates from shift
|
|
888
|
-
* Remove teammates from a shift.
|
|
889
|
-
*/
|
|
890
|
-
export declare const removeTeammatesFromShift: <ThrowOnError extends boolean = false>(options: Options<RemoveTeammatesFromShiftData, ThrowOnError>) => import("./client").RequestResult<RemoveTeammatesFromShiftResponses, unknown, ThrowOnError, "fields">;
|
|
891
|
-
/**
|
|
892
|
-
* List shift's teammates
|
|
893
|
-
* List the teammates assigned to a shift.
|
|
894
|
-
*/
|
|
895
|
-
export declare const listShiftsTeammates: <ThrowOnError extends boolean = false>(options: Options<ListShiftsTeammatesData, ThrowOnError>) => import("./client").RequestResult<ListShiftsTeammatesResponses, unknown, ThrowOnError, "fields">;
|
|
896
|
-
/**
|
|
897
|
-
* Add teammates to shift
|
|
898
|
-
* Add teammates to a shift. The selected teammates must be in the team that owns the shift.
|
|
899
|
-
*/
|
|
900
|
-
export declare const addTeammatesToShift: <ThrowOnError extends boolean = false>(options: Options<AddTeammatesToShiftData, ThrowOnError>) => import("./client").RequestResult<AddTeammatesToShiftResponses, unknown, ThrowOnError, "fields">;
|
|
901
|
-
/**
|
|
902
|
-
* Delete signature
|
|
903
|
-
* Delete signature
|
|
904
|
-
*/
|
|
905
|
-
export declare const deleteSignature: <ThrowOnError extends boolean = false>(options: Options<DeleteSignatureData, ThrowOnError>) => import("./client").RequestResult<DeleteSignatureResponses, unknown, ThrowOnError, "fields">;
|
|
906
|
-
/**
|
|
907
|
-
* Get signatures
|
|
908
|
-
* Get the given signature.
|
|
909
|
-
*/
|
|
910
|
-
export declare const getSignatures: <ThrowOnError extends boolean = false>(options: Options<GetSignaturesData, ThrowOnError>) => import("./client").RequestResult<GetSignaturesResponses, unknown, ThrowOnError, "fields">;
|
|
911
|
-
/**
|
|
912
|
-
* Update signature
|
|
913
|
-
* Update signature
|
|
914
|
-
*/
|
|
915
|
-
export declare const updateSignature: <ThrowOnError extends boolean = false>(options: Options<UpdateSignatureData, ThrowOnError>) => import("./client").RequestResult<UpdateSignatureResponses, unknown, ThrowOnError, "fields">;
|
|
916
|
-
/**
|
|
917
|
-
* List tags
|
|
918
|
-
* List all the tags of the company that the API token has access to, whether they be company tags, team tags, or teammate tags.
|
|
919
|
-
*/
|
|
920
|
-
export declare const listTags: <ThrowOnError extends boolean = false>(options?: Options<ListTagsData, ThrowOnError>) => import("./client").RequestResult<ListTagsResponses, unknown, ThrowOnError, "fields">;
|
|
921
|
-
/**
|
|
922
|
-
* Create tag
|
|
923
|
-
* Create a tag in the oldest team (workspace). This is a legacy endpoint. Use the Create company tag, Create team tag, or Create teammate tag endpoints instead.
|
|
924
|
-
*/
|
|
925
|
-
export declare const createTag: <ThrowOnError extends boolean = false>(options?: Options<CreateTagData, ThrowOnError>) => import("./client").RequestResult<CreateTagResponses, unknown, ThrowOnError, "fields">;
|
|
926
|
-
/**
|
|
927
|
-
* Delete tag
|
|
928
|
-
* Delete a tag.
|
|
929
|
-
*/
|
|
930
|
-
export declare const deleteTag: <ThrowOnError extends boolean = false>(options: Options<DeleteTagData, ThrowOnError>) => import("./client").RequestResult<DeleteTagResponses, unknown, ThrowOnError, "fields">;
|
|
931
|
-
/**
|
|
932
|
-
* Get tag
|
|
933
|
-
* Fetch a tag.
|
|
934
|
-
*/
|
|
935
|
-
export declare const getTag: <ThrowOnError extends boolean = false>(options: Options<GetTagData, ThrowOnError>) => import("./client").RequestResult<GetTagResponses, unknown, ThrowOnError, "fields">;
|
|
936
|
-
/**
|
|
937
|
-
* Update a tag
|
|
938
|
-
* Update a tag.
|
|
939
|
-
*/
|
|
940
|
-
export declare const updateATag: <ThrowOnError extends boolean = false>(options: Options<UpdateATagData, ThrowOnError>) => import("./client").RequestResult<UpdateATagResponses, unknown, ThrowOnError, "fields">;
|
|
941
|
-
/**
|
|
942
|
-
* List tag children
|
|
943
|
-
* List the children of a specific tag.
|
|
944
|
-
*/
|
|
945
|
-
export declare const listTagChildren: <ThrowOnError extends boolean = false>(options: Options<ListTagChildrenData, ThrowOnError>) => import("./client").RequestResult<ListTagChildrenResponses, unknown, ThrowOnError, "fields">;
|
|
946
|
-
/**
|
|
947
|
-
* Create child tag
|
|
948
|
-
* Creates a child tag.
|
|
949
|
-
*/
|
|
950
|
-
export declare const createChildTag: <ThrowOnError extends boolean = false>(options: Options<CreateChildTagData, ThrowOnError>) => import("./client").RequestResult<CreateChildTagResponses, unknown, ThrowOnError, "fields">;
|
|
951
|
-
/**
|
|
952
|
-
* List tagged conversations
|
|
953
|
-
* List the conversations tagged with a tag. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
|
|
954
|
-
*
|
|
955
|
-
*/
|
|
956
|
-
export declare const listTaggedConversations: <ThrowOnError extends boolean = false>(options: Options<ListTaggedConversationsData, ThrowOnError>) => import("./client").RequestResult<ListTaggedConversationsResponses, unknown, ThrowOnError, "fields">;
|
|
957
|
-
/**
|
|
958
|
-
* List teammate groups
|
|
959
|
-
* List the teammate groups in the company.
|
|
960
|
-
*/
|
|
961
|
-
export declare const listCompanyTeammateGroups: <ThrowOnError extends boolean = false>(options?: Options<ListCompanyTeammateGroupsData, ThrowOnError>) => import("./client").RequestResult<ListCompanyTeammateGroupsResponses, unknown, ThrowOnError, "fields">;
|
|
962
|
-
/**
|
|
963
|
-
* Create teammate group
|
|
964
|
-
* Create a new teammate group.
|
|
965
|
-
*/
|
|
966
|
-
export declare const createCompanyTeammateGroup: <ThrowOnError extends boolean = false>(options?: Options<CreateCompanyTeammateGroupData, ThrowOnError>) => import("./client").RequestResult<CreateCompanyTeammateGroupResponses, unknown, ThrowOnError, "fields">;
|
|
967
|
-
/**
|
|
968
|
-
* Delete teammate group
|
|
969
|
-
* Deletes a teammate group. Note - You cannot delete a teammate group that is managed by SCIM.
|
|
970
|
-
*/
|
|
971
|
-
export declare const deleteCompanyTeammateGroup: <ThrowOnError extends boolean = false>(options: Options<DeleteCompanyTeammateGroupData, ThrowOnError>) => import("./client").RequestResult<DeleteCompanyTeammateGroupResponses, unknown, ThrowOnError, "fields">;
|
|
972
|
-
/**
|
|
973
|
-
* Get teammate group
|
|
974
|
-
* Fetch a teammate group.
|
|
975
|
-
*/
|
|
976
|
-
export declare const getCompanyTeammateGroup: <ThrowOnError extends boolean = false>(options: Options<GetCompanyTeammateGroupData, ThrowOnError>) => import("./client").RequestResult<GetCompanyTeammateGroupResponses, unknown, ThrowOnError, "fields">;
|
|
977
|
-
/**
|
|
978
|
-
* Update a teammate group
|
|
979
|
-
* Updates a teammate group. Note - You cannot modify a teammate group that is managed by SCIM.
|
|
980
|
-
*/
|
|
981
|
-
export declare const updateACompanyTeammateGroup: <ThrowOnError extends boolean = false>(options: Options<UpdateACompanyTeammateGroupData, ThrowOnError>) => import("./client").RequestResult<UpdateACompanyTeammateGroupResponses, unknown, ThrowOnError, "fields">;
|
|
982
|
-
/**
|
|
983
|
-
* Remove teammate group team inboxes
|
|
984
|
-
* Unlinks non-public inboxes from the teammate group.
|
|
985
|
-
*/
|
|
986
|
-
export declare const removeCompanyTeammateGroupTeamInboxes: <ThrowOnError extends boolean = false>(options: Options<RemoveCompanyTeammateGroupTeamInboxesData, ThrowOnError>) => import("./client").RequestResult<RemoveCompanyTeammateGroupTeamInboxesResponses, unknown, ThrowOnError, "fields">;
|
|
987
|
-
/**
|
|
988
|
-
* List teammate group team inboxes
|
|
989
|
-
* List inboxes that the teammate group has access to via its associated teams.
|
|
990
|
-
*/
|
|
991
|
-
export declare const listCompanyTeammateGroupTeamInboxes: <ThrowOnError extends boolean = false>(options: Options<ListCompanyTeammateGroupTeamInboxesData, ThrowOnError>) => import("./client").RequestResult<ListCompanyTeammateGroupTeamInboxesResponses, unknown, ThrowOnError, "fields">;
|
|
992
|
-
/**
|
|
993
|
-
* Add teammate group team inboxes
|
|
994
|
-
* Links non-public inboxes to the teammate group. The inbox must be part of a team that has been added to the teammate group.
|
|
995
|
-
*/
|
|
996
|
-
export declare const addCompanyTeammateGroupTeamInboxes: <ThrowOnError extends boolean = false>(options: Options<AddCompanyTeammateGroupTeamInboxesData, ThrowOnError>) => import("./client").RequestResult<AddCompanyTeammateGroupTeamInboxesResponses, unknown, ThrowOnError, "fields">;
|
|
997
|
-
/**
|
|
998
|
-
* Remove teammate group teammates
|
|
999
|
-
* Remove teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM.
|
|
1000
|
-
*/
|
|
1001
|
-
export declare const removeCompanyTeammateGroupTeammates: <ThrowOnError extends boolean = false>(options: Options<RemoveCompanyTeammateGroupTeammatesData, ThrowOnError>) => import("./client").RequestResult<RemoveCompanyTeammateGroupTeammatesResponses, unknown, ThrowOnError, "fields">;
|
|
1002
|
-
/**
|
|
1003
|
-
* List teammate group teammates
|
|
1004
|
-
* List teammate group teammates.
|
|
1005
|
-
*/
|
|
1006
|
-
export declare const listCompanyTeammateGroupTeammates: <ThrowOnError extends boolean = false>(options: Options<ListCompanyTeammateGroupTeammatesData, ThrowOnError>) => import("./client").RequestResult<ListCompanyTeammateGroupTeammatesResponses, unknown, ThrowOnError, "fields">;
|
|
1007
|
-
/**
|
|
1008
|
-
* Add teammate group teammates
|
|
1009
|
-
* Add teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM.
|
|
1010
|
-
*/
|
|
1011
|
-
export declare const addCompanyTeammateGroupTeammates: <ThrowOnError extends boolean = false>(options: Options<AddCompanyTeammateGroupTeammatesData, ThrowOnError>) => import("./client").RequestResult<AddCompanyTeammateGroupTeammatesResponses, unknown, ThrowOnError, "fields">;
|
|
1012
|
-
/**
|
|
1013
|
-
* Remove teammate group teams
|
|
1014
|
-
* Remove teams from the teammate group. Unlinks to any associated team inboxes.
|
|
1015
|
-
*/
|
|
1016
|
-
export declare const removeCompanyTeammateGroupTeams: <ThrowOnError extends boolean = false>(options: Options<RemoveCompanyTeammateGroupTeamsData, ThrowOnError>) => import("./client").RequestResult<RemoveCompanyTeammateGroupTeamsResponses, unknown, ThrowOnError, "fields">;
|
|
1017
|
-
/**
|
|
1018
|
-
* List teammate group teams
|
|
1019
|
-
* List teams added to the teammate group. Any teams added to the teammate group will automatically link public inboxes.
|
|
1020
|
-
*/
|
|
1021
|
-
export declare const listCompanyTeammateGroupTeams: <ThrowOnError extends boolean = false>(options: Options<ListCompanyTeammateGroupTeamsData, ThrowOnError>) => import("./client").RequestResult<ListCompanyTeammateGroupTeamsResponses, unknown, ThrowOnError, "fields">;
|
|
1022
|
-
/**
|
|
1023
|
-
* Add teammate group teams
|
|
1024
|
-
* Adds teams to the teammate group. Any teams added to the teammate group will automatically link public inboxes. Non-public inboxes can be added to the teammate group separately.
|
|
1025
|
-
*/
|
|
1026
|
-
export declare const addCompanyTeammateGroupTeams: <ThrowOnError extends boolean = false>(options: Options<AddCompanyTeammateGroupTeamsData, ThrowOnError>) => import("./client").RequestResult<AddCompanyTeammateGroupTeamsResponses, unknown, ThrowOnError, "fields">;
|
|
1027
|
-
/**
|
|
1028
|
-
* List teammates
|
|
1029
|
-
* List the teammates in the company.
|
|
1030
|
-
*/
|
|
1031
|
-
export declare const listTeammates: <ThrowOnError extends boolean = false>(options?: Options<ListTeammatesData, ThrowOnError>) => import("./client").RequestResult<ListTeammatesResponses, unknown, ThrowOnError, "fields">;
|
|
1032
|
-
/**
|
|
1033
|
-
* List Teammate's custom fields
|
|
1034
|
-
* Lists the custom fields that can be attached to a Teammate.
|
|
1035
|
-
*/
|
|
1036
|
-
export declare const listTeammateCustomFields: <ThrowOnError extends boolean = false>(options?: Options<ListTeammateCustomFieldsData, ThrowOnError>) => import("./client").RequestResult<ListTeammateCustomFieldsResponses, unknown, ThrowOnError, "fields">;
|
|
1037
|
-
/**
|
|
1038
|
-
* Get teammate
|
|
1039
|
-
* Fetch a teammate.
|
|
1040
|
-
*/
|
|
1041
|
-
export declare const getTeammate: <ThrowOnError extends boolean = false>(options: Options<GetTeammateData, ThrowOnError>) => import("./client").RequestResult<GetTeammateResponses, unknown, ThrowOnError, "fields">;
|
|
1042
|
-
/**
|
|
1043
|
-
* Update teammate
|
|
1044
|
-
* Update a teammate.
|
|
1045
|
-
*/
|
|
1046
|
-
export declare const updateTeammate: <ThrowOnError extends boolean = false>(options: Options<UpdateTeammateData, ThrowOnError>) => import("./client").RequestResult<UpdateTeammateResponses, unknown, ThrowOnError, "fields">;
|
|
1047
|
-
/**
|
|
1048
|
-
* List teammate channels
|
|
1049
|
-
* List the channels of a teammate.
|
|
1050
|
-
*/
|
|
1051
|
-
export declare const listTeammateChannels: <ThrowOnError extends boolean = false>(options: Options<ListTeammateChannelsData, ThrowOnError>) => import("./client").RequestResult<ListTeammateChannelsResponses, unknown, ThrowOnError, "fields">;
|
|
1052
|
-
/**
|
|
1053
|
-
* List teammate groups
|
|
1054
|
-
* List the contact groups belonging to the requested teammate.
|
|
1055
|
-
*
|
|
1056
|
-
* > ⚠️ Deprecated endpoint
|
|
1057
|
-
* >
|
|
1058
|
-
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
1059
|
-
* > - `GET /teammates/{teammate_id}/contact_lists`.
|
|
1060
|
-
*
|
|
1061
|
-
* @deprecated
|
|
1062
|
-
*/
|
|
1063
|
-
export declare const listTeammateGroups: <ThrowOnError extends boolean = false>(options: Options<ListTeammateGroupsData, ThrowOnError>) => import("./client").RequestResult<ListTeammateGroupsResponses, unknown, ThrowOnError, "fields">;
|
|
1064
|
-
/**
|
|
1065
|
-
* Create teammate group
|
|
1066
|
-
* Create a new contact group for the requested teammate.
|
|
1067
|
-
*
|
|
1068
|
-
* > ⚠️ Deprecated endpoint
|
|
1069
|
-
* >
|
|
1070
|
-
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
1071
|
-
* > - `POST /teammates/{teammate_id}/contact_lists`.
|
|
1072
|
-
*
|
|
1073
|
-
* @deprecated
|
|
1074
|
-
*/
|
|
1075
|
-
export declare const createTeammateGroup: <ThrowOnError extends boolean = false>(options: Options<CreateTeammateGroupData, ThrowOnError>) => import("./client").RequestResult<CreateTeammateGroupResponses, unknown, ThrowOnError, "fields">;
|
|
1076
|
-
/**
|
|
1077
|
-
* List teammate contact lists
|
|
1078
|
-
* List the contact lists belonging to the requested teammate.
|
|
1079
|
-
*/
|
|
1080
|
-
export declare const listTeammateContactLists: <ThrowOnError extends boolean = false>(options: Options<ListTeammateContactListsData, ThrowOnError>) => import("./client").RequestResult<ListTeammateContactListsResponses, unknown, ThrowOnError, "fields">;
|
|
1081
|
-
/**
|
|
1082
|
-
* Create teammate contact list
|
|
1083
|
-
* Create a new contact list for the requested teammate.
|
|
1084
|
-
*/
|
|
1085
|
-
export declare const createTeammateContactList: <ThrowOnError extends boolean = false>(options: Options<CreateTeammateContactListData, ThrowOnError>) => import("./client").RequestResult<CreateTeammateContactListResponses, unknown, ThrowOnError, "fields">;
|
|
1086
|
-
/**
|
|
1087
|
-
* List teammate contacts
|
|
1088
|
-
* List the contacts of a teammate.
|
|
1089
|
-
*/
|
|
1090
|
-
export declare const listTeammateContacts: <ThrowOnError extends boolean = false>(options: Options<ListTeammateContactsData, ThrowOnError>) => import("./client").RequestResult<ListTeammateContactsResponses, unknown, ThrowOnError, "fields">;
|
|
1091
|
-
/**
|
|
1092
|
-
* Create teammate contact
|
|
1093
|
-
* Create a contact for a teammate.
|
|
1094
|
-
*/
|
|
1095
|
-
export declare const createTeammateContact: <ThrowOnError extends boolean = false>(options: Options<CreateTeammateContactData, ThrowOnError>) => import("./client").RequestResult<CreateTeammateContactResponses, unknown, ThrowOnError, "fields">;
|
|
1096
|
-
/**
|
|
1097
|
-
* List assigned conversations
|
|
1098
|
-
* List the conversations assigned to a teammate in reverse chronological order (most recently updated first). For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).
|
|
1099
|
-
*
|
|
1100
|
-
*/
|
|
1101
|
-
export declare const listAssignedConversations: <ThrowOnError extends boolean = false>(options: Options<ListAssignedConversationsData, ThrowOnError>) => import("./client").RequestResult<ListAssignedConversationsResponses, unknown, ThrowOnError, "fields">;
|
|
1102
|
-
/**
|
|
1103
|
-
* List teammate inboxes
|
|
1104
|
-
* Returns list of inboxes the teammate has access to.
|
|
1105
|
-
* @deprecated
|
|
1106
|
-
*/
|
|
1107
|
-
export declare const listTeammateInboxes: <ThrowOnError extends boolean = false>(options: Options<ListTeammateInboxesData, ThrowOnError>) => import("./client").RequestResult<ListTeammateInboxesResponses, unknown, ThrowOnError, "fields">;
|
|
1108
|
-
/**
|
|
1109
|
-
* List teammate folders
|
|
1110
|
-
* List the message template folders belonging to the requested teammate.
|
|
1111
|
-
*/
|
|
1112
|
-
export declare const listTeammateFolders: <ThrowOnError extends boolean = false>(options: Options<ListTeammateFoldersData, ThrowOnError>) => import("./client").RequestResult<ListTeammateFoldersResponses, unknown, ThrowOnError, "fields">;
|
|
1113
|
-
/**
|
|
1114
|
-
* Create teammate folder
|
|
1115
|
-
* Create a new message template folder belonging to the requested teammate.
|
|
1116
|
-
*/
|
|
1117
|
-
export declare const createTeammateFolder: <ThrowOnError extends boolean = false>(options: Options<CreateTeammateFolderData, ThrowOnError>) => import("./client").RequestResult<CreateTeammateFolderResponses, unknown, ThrowOnError, "fields">;
|
|
1118
|
-
/**
|
|
1119
|
-
* List teammate message templates
|
|
1120
|
-
* List the message templates belonging to the requested teammate.
|
|
1121
|
-
*/
|
|
1122
|
-
export declare const listTeammateMessageTemplates: <ThrowOnError extends boolean = false>(options: Options<ListTeammateMessageTemplatesData, ThrowOnError>) => import("./client").RequestResult<ListTeammateMessageTemplatesResponses, unknown, ThrowOnError, "fields">;
|
|
1123
|
-
/**
|
|
1124
|
-
* Create teammate message template
|
|
1125
|
-
* Create a new message template for the given teammate
|
|
1126
|
-
*/
|
|
1127
|
-
export declare const createTeammateMessageTemplate: <ThrowOnError extends boolean = false>(options: Options<CreateTeammateMessageTemplateData, ThrowOnError>) => import("./client").RequestResult<CreateTeammateMessageTemplateResponses, unknown, ThrowOnError, "fields">;
|
|
1128
|
-
/**
|
|
1129
|
-
* List teammate rules
|
|
1130
|
-
* List the rules of a teammate.
|
|
1131
|
-
*/
|
|
1132
|
-
export declare const listTeammateRules: <ThrowOnError extends boolean = false>(options: Options<ListTeammateRulesData, ThrowOnError>) => import("./client").RequestResult<ListTeammateRulesResponses, unknown, ThrowOnError, "fields">;
|
|
1133
|
-
/**
|
|
1134
|
-
* List Teammate Shifts
|
|
1135
|
-
* Lists all the shifts for the teammate.
|
|
1136
|
-
*/
|
|
1137
|
-
export declare const listTeammateShifts: <ThrowOnError extends boolean = false>(options: Options<ListTeammateShiftsData, ThrowOnError>) => import("./client").RequestResult<ListTeammateShiftsResponses, unknown, ThrowOnError, "fields">;
|
|
1138
|
-
/**
|
|
1139
|
-
* List teammate signatures
|
|
1140
|
-
* List the signatures belonging to the given teammate.
|
|
1141
|
-
*/
|
|
1142
|
-
export declare const listTeammateSignatures: <ThrowOnError extends boolean = false>(options: Options<ListTeammateSignaturesData, ThrowOnError>) => import("./client").RequestResult<ListTeammateSignaturesResponses, unknown, ThrowOnError, "fields">;
|
|
1143
|
-
/**
|
|
1144
|
-
* Create teammate signature
|
|
1145
|
-
* Create a new signature for the given teammate
|
|
1146
|
-
*/
|
|
1147
|
-
export declare const createTeammateSignature: <ThrowOnError extends boolean = false>(options: Options<CreateTeammateSignatureData, ThrowOnError>) => import("./client").RequestResult<CreateTeammateSignatureResponses, unknown, ThrowOnError, "fields">;
|
|
1148
|
-
/**
|
|
1149
|
-
* List teammate tags
|
|
1150
|
-
* List the tags for a teammate.
|
|
1151
|
-
*/
|
|
1152
|
-
export declare const listTeammateTags: <ThrowOnError extends boolean = false>(options: Options<ListTeammateTagsData, ThrowOnError>) => import("./client").RequestResult<ListTeammateTagsResponses, unknown, ThrowOnError, "fields">;
|
|
1153
|
-
/**
|
|
1154
|
-
* Create teammate tag
|
|
1155
|
-
* Create a tag for a teammate.
|
|
1156
|
-
*/
|
|
1157
|
-
export declare const createTeammateTag: <ThrowOnError extends boolean = false>(options: Options<CreateTeammateTagData, ThrowOnError>) => import("./client").RequestResult<CreateTeammateTagResponses, unknown, ThrowOnError, "fields">;
|
|
1158
|
-
/**
|
|
1159
|
-
* List teams
|
|
1160
|
-
* List the teams (workspaces) in the company.
|
|
1161
|
-
*/
|
|
1162
|
-
export declare const listTeams: <ThrowOnError extends boolean = false>(options?: Options<ListTeamsData, ThrowOnError>) => import("./client").RequestResult<ListTeamsResponses, unknown, ThrowOnError, "fields">;
|
|
1163
|
-
/**
|
|
1164
|
-
* Get team
|
|
1165
|
-
* Fetch a team (workspace).
|
|
1166
|
-
*/
|
|
1167
|
-
export declare const getTeam: <ThrowOnError extends boolean = false>(options: Options<GetTeamData, ThrowOnError>) => import("./client").RequestResult<GetTeamResponses, unknown, ThrowOnError, "fields">;
|
|
1168
|
-
/**
|
|
1169
|
-
* List team channels
|
|
1170
|
-
* List the channels of a team (workspace).
|
|
1171
|
-
*/
|
|
1172
|
-
export declare const listTeamChannels: <ThrowOnError extends boolean = false>(options: Options<ListTeamChannelsData, ThrowOnError>) => import("./client").RequestResult<ListTeamChannelsResponses, unknown, ThrowOnError, "fields">;
|
|
1173
|
-
/**
|
|
1174
|
-
* List team groups
|
|
1175
|
-
* List contact groups belonging to the requested team (workspace).
|
|
1176
|
-
*
|
|
1177
|
-
* > ⚠️ Deprecated endpoint
|
|
1178
|
-
* >
|
|
1179
|
-
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
1180
|
-
* > - `GET /teams/{team_id}/contact_lists`.
|
|
1181
|
-
*
|
|
1182
|
-
* @deprecated
|
|
1183
|
-
*/
|
|
1184
|
-
export declare const listTeamGroups: <ThrowOnError extends boolean = false>(options: Options<ListTeamGroupsData, ThrowOnError>) => import("./client").RequestResult<ListTeamGroupsResponses, unknown, ThrowOnError, "fields">;
|
|
1185
|
-
/**
|
|
1186
|
-
* Create team group
|
|
1187
|
-
* Create a new contact group for the requested team (workspace).
|
|
1188
|
-
*
|
|
1189
|
-
* > ⚠️ Deprecated endpoint
|
|
1190
|
-
* >
|
|
1191
|
-
* > This endpoint has been deprecated. Please use the compatible contact list endpoints instead.
|
|
1192
|
-
* > - `POST /teams/{team_id}/contact_lists`.
|
|
1193
|
-
*
|
|
1194
|
-
* @deprecated
|
|
1195
|
-
*/
|
|
1196
|
-
export declare const createTeamGroup: <ThrowOnError extends boolean = false>(options: Options<CreateTeamGroupData, ThrowOnError>) => import("./client").RequestResult<CreateTeamGroupResponses, unknown, ThrowOnError, "fields">;
|
|
1197
|
-
/**
|
|
1198
|
-
* List team contact lists
|
|
1199
|
-
* List contact lists belonging to the requested team (workspace).
|
|
1200
|
-
*/
|
|
1201
|
-
export declare const listTeamContactLists: <ThrowOnError extends boolean = false>(options: Options<ListTeamContactListsData, ThrowOnError>) => import("./client").RequestResult<ListTeamContactListsResponses, unknown, ThrowOnError, "fields">;
|
|
1202
|
-
/**
|
|
1203
|
-
* Create team contact list
|
|
1204
|
-
* Create a new contact list for the requested team (workspace).
|
|
1205
|
-
*/
|
|
1206
|
-
export declare const createTeamContactList: <ThrowOnError extends boolean = false>(options: Options<CreateTeamContactListData, ThrowOnError>) => import("./client").RequestResult<CreateTeamContactListResponses, unknown, ThrowOnError, "fields">;
|
|
1207
|
-
/**
|
|
1208
|
-
* List team contacts
|
|
1209
|
-
* List the contacts of a team (workspace).
|
|
1210
|
-
*/
|
|
1211
|
-
export declare const listTeamContacts: <ThrowOnError extends boolean = false>(options: Options<ListTeamContactsData, ThrowOnError>) => import("./client").RequestResult<ListTeamContactsResponses, unknown, ThrowOnError, "fields">;
|
|
1212
|
-
/**
|
|
1213
|
-
* Create team contact
|
|
1214
|
-
* Create a contact for a team (workspace).
|
|
1215
|
-
*/
|
|
1216
|
-
export declare const createTeamContact: <ThrowOnError extends boolean = false>(options: Options<CreateTeamContactData, ThrowOnError>) => import("./client").RequestResult<CreateTeamContactResponses, unknown, ThrowOnError, "fields">;
|
|
1217
|
-
/**
|
|
1218
|
-
* List team inboxes
|
|
1219
|
-
* List the inboxes belonging to a team (workspace).
|
|
1220
|
-
*/
|
|
1221
|
-
export declare const listTeamInboxes: <ThrowOnError extends boolean = false>(options: Options<ListTeamInboxesData, ThrowOnError>) => import("./client").RequestResult<ListTeamInboxesResponses, unknown, ThrowOnError, "fields">;
|
|
1222
|
-
/**
|
|
1223
|
-
* Create team inbox
|
|
1224
|
-
* Create an inbox for a team (workspace).
|
|
1225
|
-
*/
|
|
1226
|
-
export declare const createTeamInbox: <ThrowOnError extends boolean = false>(options: Options<CreateTeamInboxData, ThrowOnError>) => import("./client").RequestResult<CreateTeamInboxResponses, unknown, ThrowOnError, "fields">;
|
|
1227
|
-
/**
|
|
1228
|
-
* List team folders
|
|
1229
|
-
* List the message template folders belonging to the requested team (workspace).
|
|
1230
|
-
*/
|
|
1231
|
-
export declare const listTeamFolders: <ThrowOnError extends boolean = false>(options: Options<ListTeamFoldersData, ThrowOnError>) => import("./client").RequestResult<ListTeamFoldersResponses, unknown, ThrowOnError, "fields">;
|
|
1232
|
-
/**
|
|
1233
|
-
* Create team folder
|
|
1234
|
-
* Create a new message template folder belonging to the requested team (workspace).
|
|
1235
|
-
*/
|
|
1236
|
-
export declare const createTeamFolder: <ThrowOnError extends boolean = false>(options: Options<CreateTeamFolderData, ThrowOnError>) => import("./client").RequestResult<CreateTeamFolderResponses, unknown, ThrowOnError, "fields">;
|
|
1237
|
-
/**
|
|
1238
|
-
* List team message templates
|
|
1239
|
-
* List the message templates belonging to the requested team (workspace).
|
|
1240
|
-
*/
|
|
1241
|
-
export declare const listTeamMessageTemplates: <ThrowOnError extends boolean = false>(options: Options<ListTeamMessageTemplatesData, ThrowOnError>) => import("./client").RequestResult<ListTeamMessageTemplatesResponses, unknown, ThrowOnError, "fields">;
|
|
1242
|
-
/**
|
|
1243
|
-
* Create team message template
|
|
1244
|
-
* Create a new message template for the given team (workspace).
|
|
1245
|
-
*/
|
|
1246
|
-
export declare const createTeamMessageTemplate: <ThrowOnError extends boolean = false>(options: Options<CreateTeamMessageTemplateData, ThrowOnError>) => import("./client").RequestResult<CreateTeamMessageTemplateResponses, unknown, ThrowOnError, "fields">;
|
|
1247
|
-
/**
|
|
1248
|
-
* List team rules
|
|
1249
|
-
* List the rules of a team (workspace).
|
|
1250
|
-
*/
|
|
1251
|
-
export declare const listTeamRules: <ThrowOnError extends boolean = false>(options: Options<ListTeamRulesData, ThrowOnError>) => import("./client").RequestResult<ListTeamRulesResponses, unknown, ThrowOnError, "fields">;
|
|
1252
|
-
/**
|
|
1253
|
-
* List team Shifts
|
|
1254
|
-
* List the shifts for a team (workspace).
|
|
1255
|
-
*/
|
|
1256
|
-
export declare const listTeamShifts: <ThrowOnError extends boolean = false>(options: Options<ListTeamShiftsData, ThrowOnError>) => import("./client").RequestResult<ListTeamShiftsResponses, unknown, ThrowOnError, "fields">;
|
|
1257
|
-
/**
|
|
1258
|
-
* Create team shift
|
|
1259
|
-
* Create a shift for a team (workspace).
|
|
1260
|
-
*/
|
|
1261
|
-
export declare const createTeamShift: <ThrowOnError extends boolean = false>(options: Options<CreateTeamShiftData, ThrowOnError>) => import("./client").RequestResult<CreateTeamShiftResponses, unknown, ThrowOnError, "fields">;
|
|
1262
|
-
/**
|
|
1263
|
-
* List team signatures
|
|
1264
|
-
* List the signatures belonging to the given team (workspace).
|
|
1265
|
-
*/
|
|
1266
|
-
export declare const listTeamSignatures: <ThrowOnError extends boolean = false>(options: Options<ListTeamSignaturesData, ThrowOnError>) => import("./client").RequestResult<ListTeamSignaturesResponses, unknown, ThrowOnError, "fields">;
|
|
1267
|
-
/**
|
|
1268
|
-
* Create team signature
|
|
1269
|
-
* Create a new signature for the given team (workspace).
|
|
1270
|
-
*/
|
|
1271
|
-
export declare const createTeamSignature: <ThrowOnError extends boolean = false>(options: Options<CreateTeamSignatureData, ThrowOnError>) => import("./client").RequestResult<CreateTeamSignatureResponses, unknown, ThrowOnError, "fields">;
|
|
1272
|
-
/**
|
|
1273
|
-
* List team tags
|
|
1274
|
-
* List the tags for a team (workspace).
|
|
1275
|
-
*/
|
|
1276
|
-
export declare const listTeamTags: <ThrowOnError extends boolean = false>(options: Options<ListTeamTagsData, ThrowOnError>) => import("./client").RequestResult<ListTeamTagsResponses, unknown, ThrowOnError, "fields">;
|
|
1277
|
-
/**
|
|
1278
|
-
* Create team tag
|
|
1279
|
-
* Create a tag for a team (workspace).
|
|
1280
|
-
*/
|
|
1281
|
-
export declare const createTeamTag: <ThrowOnError extends boolean = false>(options: Options<CreateTeamTagData, ThrowOnError>) => import("./client").RequestResult<CreateTeamTagResponses, unknown, ThrowOnError, "fields">;
|
|
1282
|
-
/**
|
|
1283
|
-
* Remove teammates from team
|
|
1284
|
-
* Remove one or more teammates from a team (workspace).
|
|
1285
|
-
*/
|
|
1286
|
-
export declare const removeTeammatesFromTeam: <ThrowOnError extends boolean = false>(options: Options<RemoveTeammatesFromTeamData, ThrowOnError>) => import("./client").RequestResult<RemoveTeammatesFromTeamResponses, unknown, ThrowOnError, "fields">;
|
|
1287
|
-
/**
|
|
1288
|
-
* Add teammates to team
|
|
1289
|
-
* Add one or more teammates to a team (workspace).
|
|
1290
|
-
*/
|
|
1291
|
-
export declare const addTeammatesToTeam: <ThrowOnError extends boolean = false>(options: Options<AddTeammatesToTeamData, ThrowOnError>) => import("./client").RequestResult<AddTeammatesToTeamResponses, unknown, ThrowOnError, "fields">;
|
|
1292
|
-
//# sourceMappingURL=sdk.gen.d.ts.map
|