api.md

Whoami

Types:

• WhoamiRetrieveResponse

Methods:

• client.whoami.retrieve() -> WhoamiRetrieveResponse

Accounts

Types:

• AccountListResponse
• AccountDisconnectResponse

Methods:

• client.accounts.list({ ...params }) -> AccountListResponse
• client.accounts.disconnect(id) -> AccountDisconnectResponse | null

Me

Types:

• MeRetrieveResponse
• MeGetModelStartDateResponse
• MeGetTopPercentageResponse

Methods:

• client.me.retrieve(account) -> MeRetrieveResponse
• client.me.getModelStartDate(account) -> MeGetModelStartDateResponse
• client.me.getTopPercentage(account) -> MeGetTopPercentageResponse

Analytics

Financial

Types:

• FinancialGetForecastResponse

Methods:

• client.analytics.financial.getForecast({ ...params }) -> FinancialGetForecastResponse

Transactions

Types:

• TransactionGetByTypeResponse
• TransactionGetSummaryResponse

Methods:

• client.analytics.financial.transactions.getByType({ ...params }) -> TransactionGetByTypeResponse
• client.analytics.financial.transactions.getSummary({ ...params }) -> TransactionGetSummaryResponse

Profitability

Types:

• ProfitabilityGetHistoryResponse
• ProfitabilityGetProfitabilityResponse

Methods:

• client.analytics.financial.profitability.getHistory(account, { ...params }) -> ProfitabilityGetHistoryResponse
• client.analytics.financial.profitability.getProfitability({ ...params }) -> ProfitabilityGetProfitabilityResponse

Summary

Types:

• SummaryGetEarningsOverviewResponse
• SummaryGetHistoricalPerformanceResponse
• SummaryGetPeriodComparisonResponse

Methods:

• client.analytics.summary.getEarningsOverview({ ...params }) -> SummaryGetEarningsOverviewResponse
• client.analytics.summary.getHistoricalPerformance({ ...params }) -> SummaryGetHistoricalPerformanceResponse
• client.analytics.summary.getPeriodComparison({ ...params }) -> SummaryGetPeriodComparisonResponse

Banking

Types:

• BankingListAvailablePayoutSystemsResponse
• BankingListCountriesResponse

Methods:

• client.banking.listAvailablePayoutSystems(account) -> BankingListAvailablePayoutSystemsResponse
• client.banking.listCountries(account) -> BankingListCountriesResponse

Details

Types:

• DetailRetrieveAccountCountryDetailsResponse
• DetailRetrieveBankDetailsResponse
• DetailRetrieveDac7FormDetailsResponse
• DetailRetrieveLegalAndTaxStatusResponse
• DetailRetrieveLegalFormDetailsResponse

Methods:

• client.banking.details.retrieveAccountCountryDetails(account) -> DetailRetrieveAccountCountryDetailsResponse
• client.banking.details.retrieveBankDetails(account) -> DetailRetrieveBankDetailsResponse
• client.banking.details.retrieveDac7FormDetails(account) -> DetailRetrieveDac7FormDetailsResponse
• client.banking.details.retrieveLegalAndTaxStatus(account) -> DetailRetrieveLegalAndTaxStatusResponse
• client.banking.details.retrieveLegalFormDetails(account) -> DetailRetrieveLegalFormDetailsResponse

Chargebacks

Types:

• ChargebackListResponse
• ChargebackCalculateRatioResponse
• ChargebackListStatisticsResponse

Methods:

• client.chargebacks.list(account, { ...params }) -> ChargebackListResponse
• client.chargebacks.calculateRatio(account, { ...params }) -> ChargebackCalculateRatioResponse
• client.chargebacks.listStatistics(account, { ...params }) -> ChargebackListStatisticsResponse

Chats

Types:

• ChatListResponse
• ChatDeleteResponse
• ChatHideResponse
• ChatListMediaResponse
• ChatMarkAsReadResponse
• ChatMarkAsUnreadResponse
• ChatMuteResponse
• ChatStartTypingResponse
• ChatUnmuteResponse

Methods:

• client.chats.list(account, { ...params }) -> ChatListResponse
• client.chats.delete(chatID, { ...params }) -> ChatDeleteResponse
• client.chats.hide(chatID, { ...params }) -> ChatHideResponse
• client.chats.listMedia(chatID, { ...params }) -> ChatListMediaResponse
• client.chats.markAsRead(chatID, { ...params }) -> ChatMarkAsReadResponse
• client.chats.markAsUnread(chatID, { ...params }) -> ChatMarkAsUnreadResponse
• client.chats.mute(chatID, { ...params }) -> ChatMuteResponse
• client.chats.startTyping(chatID, { ...params }) -> ChatStartTypingResponse
• client.chats.unmute(chatID, { ...params }) -> ChatUnmuteResponse

Messages

Types:

• MessageRetrieveResponse
• MessageListResponse
• MessageDeleteResponse
• MessageLikeResponse
• MessagePinResponse
• MessageSearchResponse
• MessageSendResponse
• MessageUnlikeResponse
• MessageUnpinResponse

Methods:

• client.chats.messages.retrieve(messageID, { ...params }) -> MessageRetrieveResponse
• client.chats.messages.list(chatID, { ...params }) -> MessageListResponse
• client.chats.messages.delete(messageID, { ...params }) -> MessageDeleteResponse
• client.chats.messages.like(messageID, { ...params }) -> MessageLikeResponse
• client.chats.messages.pin(messageID, { ...params }) -> MessagePinResponse
• client.chats.messages.search(chatID, { ...params }) -> MessageSearchResponse
• client.chats.messages.send(chatID, { ...params }) -> MessageSendResponse
• client.chats.messages.unlike(messageID, { ...params }) -> MessageUnlikeResponse
• client.chats.messages.unpin(messageID, { ...params }) -> MessageUnpinResponse

MarkAllAsRead

Types:

• MarkAllAsReadAllResponse

Methods:

• client.chats.markAllAsRead.all(account) -> MarkAllAsReadAllResponse

Messages

Types:

• MessageAttachTagsResponse

Methods:

• client.messages.attachTags(messageID, { ...params }) -> MessageAttachTagsResponse

ClientSessions

Types:

• ClientSessionCreateResponse

Methods:

• client.clientSessions.create({ ...params }) -> ClientSessionCreateResponse

Authenticate

Types:

• AuthenticatePollStatusResponse
• AuthenticateReauthenticateResponse
• AuthenticateSend2faEmailResponse
• AuthenticateStartResponse
• AuthenticateSubmit2faResponse

Methods:

• client.authenticate.pollStatus(attemptID) -> AuthenticatePollStatusResponse
• client.authenticate.reauthenticate(accountID) -> AuthenticateReauthenticateResponse
• client.authenticate.send2faEmail(attemptID) -> AuthenticateSend2faEmailResponse
• client.authenticate.start({ ...params }) -> AuthenticateStartResponse
• client.authenticate.submit2fa(attemptID, { ...params }) -> AuthenticateSubmit2faResponse

DataExports

Types:

• DataExportCreateResponse
• DataExportRetrieveResponse
• DataExportListResponse
• DataExportCancelResponse
• DataExportRetryResponse
• DataExportStartResponse

Methods:

• client.dataExports.create({ ...params }) -> DataExportCreateResponse
• client.dataExports.retrieve(dataExportID, { ...params }) -> DataExportRetrieveResponse
• client.dataExports.list({ ...params }) -> DataExportListResponse
• client.dataExports.cancel(dataExportID) -> DataExportCancelResponse
• client.dataExports.retry(dataExportID) -> DataExportRetryResponse
• client.dataExports.start(dataExportID) -> DataExportStartResponse

Engagement

Messages

Types:

• MessageGetMessageBuyersResponse
• MessageGetTopMessageResponse

Methods:

• client.engagement.messages.getMessageBuyers(messageID, { ...params }) -> MessageGetMessageBuyersResponse
• client.engagement.messages.getTopMessage(account, { ...params }) -> MessageGetTopMessageResponse

MassMessages

Types:

• MassMessageListResponse
• MassMessageChartResponse

Methods:

• client.engagement.messages.massMessages.list(account, { ...params }) -> MassMessageListResponse
• client.engagement.messages.massMessages.chart(account, { ...params }) -> MassMessageChartResponse

DirectMessages

Types:

• DirectMessageListResponse
• DirectMessageChartResponse

Methods:

• client.engagement.messages.directMessages.list(account, { ...params }) -> DirectMessageListResponse
• client.engagement.messages.directMessages.chart(account, { ...params }) -> DirectMessageChartResponse

Fans

Types:

• FanGetSubscriptionHistoryResponse
• FanListActiveResponse
• FanListAllResponse
• FanListExpiredResponse
• FanListLatestResponse
• FanListTopResponse
• FanSetCustomNameResponse

Methods:

• client.fans.getSubscriptionHistory(userID, { ...params }) -> FanGetSubscriptionHistoryResponse
• client.fans.listActive(account, { ...params }) -> FanListActiveResponse
• client.fans.listAll(account, { ...params }) -> FanListAllResponse
• client.fans.listExpired(account, { ...params }) -> FanListExpiredResponse
• client.fans.listLatest(account, { ...params }) -> FanListLatestResponse
• client.fans.listTop(account, { ...params }) -> FanListTopResponse
• client.fans.setCustomName(fanID, { ...params }) -> FanSetCustomNameResponse

Notes

Types:

• NoteClearNotesResponse
• NoteCreateEditNotesResponse
• NoteGetNotesResponse

Methods:

• client.fans.notes.clearNotes(fanID, { ...params }) -> NoteClearNotesResponse
• client.fans.notes.createEditNotes(fanID, { ...params }) -> NoteCreateEditNotesResponse
• client.fans.notes.getNotes(fanID, { ...params }) -> NoteGetNotesResponse

Summary

Types:

• SummaryGenerateSummaryResponse
• SummaryGetSummaryResponse

Methods:

• client.fans.summary.generateSummary(fanID, { ...params }) -> SummaryGenerateSummaryResponse
• client.fans.summary.getSummary(fanID, { ...params }) -> SummaryGetSummaryResponse

Following

Types:

• FollowingListActiveResponse
• FollowingListAllResponse
• FollowingListExpiredResponse

Methods:

• client.following.listActive(account, { ...params }) -> FollowingListActiveResponse
• client.following.listAll(account, { ...params }) -> FollowingListAllResponse
• client.following.listExpired(account, { ...params }) -> FollowingListExpiredResponse

TrialLinks

Types:

• TrialLinkCreateResponse
• TrialLinkRetrieveResponse
• TrialLinkListResponse
• TrialLinkDeleteResponse
• TrialLinkListSpendersResponse
• TrialLinkListSubscribersResponse
• TrialLinkRetrieveStatsResponse

Methods:

• client.trialLinks.create(account, { ...params }) -> TrialLinkCreateResponse
• client.trialLinks.retrieve(trialLinkID, { ...params }) -> TrialLinkRetrieveResponse
• client.trialLinks.list(account, { ...params }) -> TrialLinkListResponse
• client.trialLinks.delete(trialLinkID, { ...params }) -> TrialLinkDeleteResponse
• client.trialLinks.listSpenders(trialLinkID, { ...params }) -> TrialLinkListSpendersResponse
• client.trialLinks.listSubscribers(trialLinkID, { ...params }) -> TrialLinkListSubscribersResponse
• client.trialLinks.retrieveCohortArps(trialLinkID, { ...params }) -> void
• client.trialLinks.retrieveStats(trialLinkID, { ...params }) -> TrialLinkRetrieveStatsResponse

Tags

Types:

• TagListResponse
• TagAddResponse
• TagRemoveResponse

Methods:

• client.trialLinks.tags.list(trialLinkID, { ...params }) -> TagListResponse
• client.trialLinks.tags.add(trialLinkID, { ...params }) -> TagAddResponse
• client.trialLinks.tags.remove(trialLinkID, { ...params }) -> TagRemoveResponse

Giphy

Types:

• GiphyListTrendingResponse
• GiphySearchResponse

Methods:

• client.giphy.listTrending(account, { ...params }) -> GiphyListTrendingResponse
• client.giphy.search(account, { ...params }) -> GiphySearchResponse

LinkTags

Types:

• LinkTagListResponse

Methods:

• client.linkTags.list({ ...params }) -> LinkTagListResponse

MassMessaging

Types:

• MassMessagingRetrieveResponse
• MassMessagingUpdateResponse
• MassMessagingListResponse
• MassMessagingDeleteResponse
• MassMessagingRetrieveOverviewResponse
• MassMessagingSendResponse

Methods:

• client.massMessaging.retrieve(id, { ...params }) -> MassMessagingRetrieveResponse
• client.massMessaging.update(id, { ...params }) -> MassMessagingUpdateResponse
• client.massMessaging.list(account) -> MassMessagingListResponse
• client.massMessaging.delete(id, { ...params }) -> MassMessagingDeleteResponse
• client.massMessaging.retrieveOverview(account, { ...params }) -> MassMessagingRetrieveOverviewResponse
• client.massMessaging.send(account, { ...params }) -> MassMessagingSendResponse

Media

Types:

• MediaDownloadResponse
• MediaScrapeResponse
• MediaUploadResponse

Methods:

• client.media.download(cdnURL, { ...params }) -> string
• client.media.scrape(account, { ...params }) -> MediaScrapeResponse
• client.media.upload(account, { ...params }) -> MediaUploadResponse

Uploads

Types:

• UploadGetStatusResponse

Methods:

• client.media.uploads.getStatus(upload, { ...params }) -> UploadGetStatusResponse

Vault

Types:

• VaultRetrieveResponse
• VaultListResponse
• VaultDeleteResponse
• VaultUploadResponse

Methods:

• client.media.vault.retrieve(mediaID, { ...params }) -> VaultRetrieveResponse
• client.media.vault.list(account, { ...params }) -> VaultListResponse
• client.media.vault.delete(account, { ...params }) -> VaultDeleteResponse
• client.media.vault.upload(account, { ...params }) -> VaultUploadResponse

Lists

Types:

• ListCreateResponse
• ListRetrieveResponse
• ListUpdateResponse
• ListListResponse
• ListDeleteResponse

Methods:

• client.media.vault.lists.create(account, { ...params }) -> ListCreateResponse
• client.media.vault.lists.retrieve(listID, { ...params }) -> ListRetrieveResponse
• client.media.vault.lists.update(listID, { ...params }) -> ListUpdateResponse
• client.media.vault.lists.list(account, { ...params }) -> ListListResponse
• client.media.vault.lists.delete(listID, { ...params }) -> ListDeleteResponse

Media

Types:

• MediaAddResponse
• MediaRemoveResponse

Methods:

• client.media.vault.lists.media.add(listID, { ...params }) -> MediaAddResponse
• client.media.vault.lists.media.remove(listID, { ...params }) -> MediaRemoveResponse

Notifications

Types:

• NotificationListResponse
• NotificationGetCountsResponse
• NotificationMarkAllAsReadResponse
• NotificationSearchUsersResponse

Methods:

• client.notifications.list(account, { ...params }) -> NotificationListResponse
• client.notifications.getCounts(account) -> NotificationGetCountsResponse
• client.notifications.markAllAsRead(account) -> NotificationMarkAllAsReadResponse
• client.notifications.searchUsers(account, { ...params }) -> NotificationSearchUsersResponse

TabsOrder

Types:

• TabsOrderUpdateResponse
• TabsOrderGetResponse

Methods:

• client.notifications.tabsOrder.update(account, { ...params }) -> TabsOrderUpdateResponse
• client.notifications.tabsOrder.get(account) -> TabsOrderGetResponse

Payouts

Types:

• PayoutListRequestsResponse
• PayoutRequestManualWithdrawalResponse
• PayoutRetrieveBalancesResponse
• PayoutRetrieveEarningStatisticsResponse
• PayoutRetrieveEligibilityResponse
• PayoutUpdateFrequencyResponse

Methods:

• client.payouts.listRequests(account, { ...params }) -> PayoutListRequestsResponse
• client.payouts.requestManualWithdrawal(account, { ...params }) -> PayoutRequestManualWithdrawalResponse
• client.payouts.retrieveBalances(account) -> PayoutRetrieveBalancesResponse
• client.payouts.retrieveEarningStatistics(account, { ...params }) -> PayoutRetrieveEarningStatisticsResponse
• client.payouts.retrieveEligibility(account) -> PayoutRetrieveEligibilityResponse
• client.payouts.updateFrequency(account, { ...params }) -> PayoutUpdateFrequencyResponse

Posts

Types:

• PostCreateResponse
• PostRetrieveResponse
• PostUpdateResponse
• PostListResponse
• PostDeleteResponse
• PostArchiveResponse
• PostPinResponse
• PostStatsResponse
• PostUnarchiveResponse

Methods:

• client.posts.create(account, { ...params }) -> PostCreateResponse
• client.posts.retrieve(postID, { ...params }) -> PostRetrieveResponse
• client.posts.update(postID, { ...params }) -> string
• client.posts.list(account, { ...params }) -> PostListResponse
• client.posts.delete(postID, { ...params }) -> PostDeleteResponse
• client.posts.archive(postID, { ...params }) -> PostArchiveResponse
• client.posts.pin(postID, { ...params }) -> PostPinResponse
• client.posts.stats(postID, { ...params }) -> PostStatsResponse
• client.posts.unarchive(postID, { ...params }) -> PostUnarchiveResponse

Comments

Types:

• CommentCreateResponse
• CommentListResponse
• CommentDeleteResponse
• CommentLikeResponse
• CommentPinResponse
• CommentUnlikeResponse
• CommentUnpinResponse

Methods:

• client.posts.comments.create(postID, { ...params }) -> CommentCreateResponse
• client.posts.comments.list(postID, { ...params }) -> CommentListResponse
• client.posts.comments.delete(commentID, { ...params }) -> CommentDeleteResponse
• client.posts.comments.like(commentID, { ...params }) -> CommentLikeResponse
• client.posts.comments.pin(commentID, { ...params }) -> CommentPinResponse
• client.posts.comments.unlike(commentID, { ...params }) -> CommentUnlikeResponse
• client.posts.comments.unpin(commentID, { ...params }) -> CommentUnpinResponse

Labels

Types:

• LabelCreateResponse
• LabelListResponse

Methods:

• client.posts.labels.create(account, { ...params }) -> LabelCreateResponse
• client.posts.labels.list(account, { ...params }) -> LabelListResponse

Promotions

Types:

• PromotionCreateResponse
• PromotionListResponse
• PromotionDeleteResponse
• PromotionStopResponse

Methods:

• client.promotions.create(account, { ...params }) -> PromotionCreateResponse
• client.promotions.list(account, { ...params }) -> PromotionListResponse
• client.promotions.delete(promotionID, { ...params }) -> PromotionDeleteResponse
• client.promotions.stop(promotionID, { ...params }) -> PromotionStopResponse

Profiles

Types:

• ProfileRetrieveResponse

Methods:

• client.profiles.retrieve(username, { ...params }) -> ProfileRetrieveResponse

Search

Types:

• SearchProfilesResponse

Methods:

• client.search.profiles({ ...params }) -> SearchProfilesResponse

Queue

Types:

• QueueListResponse
• QueueCountResponse
• QueuePublishResponse

Methods:

• client.queue.list(account, { ...params }) -> QueueListResponse
• client.queue.count(account, { ...params }) -> QueueCountResponse
• client.queue.publish(queueID, { ...params }) -> QueuePublishResponse

ReleaseForms

Types:

• ReleaseFormCreateInvitationLinkResponse
• ReleaseFormCreateReleaseFormResponse
• ReleaseFormListTaggableUsersResponse

Methods:

• client.releaseForms.createInvitationLink(account, { ...params }) -> ReleaseFormCreateInvitationLinkResponse
• client.releaseForms.createReleaseForm(account, { ...params }) -> ReleaseFormCreateReleaseFormResponse
• client.releaseForms.listTaggableUsers(account, { ...params }) -> ReleaseFormListTaggableUsersResponse

SavedForLater

Messages

Types:

• MessageListResponse

Methods:

• client.savedForLater.messages.list(account, { ...params }) -> MessageListResponse

Settings

Types:

• SettingRetrieveResponse
• SettingDisableAutomaticMessagingResponse
• SettingEnableOrUpdateAutomaticMessagingResponse

Methods:

• client.savedForLater.messages.settings.retrieve(account) -> SettingRetrieveResponse
• client.savedForLater.messages.settings.disableAutomaticMessaging(account) -> SettingDisableAutomaticMessagingResponse
• client.savedForLater.messages.settings.enableOrUpdateAutomaticMessaging(account, { ...params }) -> SettingEnableOrUpdateAutomaticMessagingResponse

Posts

Types:

• PostListResponse

Methods:

• client.savedForLater.posts.list(account, { ...params }) -> PostListResponse

Settings

Types:

• SettingRetrieveResponse
• SettingDisableAutomaticPostingResponse
• SettingEnableOrUpdateAutomaticPostingResponse

Methods:

• client.savedForLater.posts.settings.retrieve(account) -> SettingRetrieveResponse
• client.savedForLater.posts.settings.disableAutomaticPosting(account) -> SettingDisableAutomaticPostingResponse
• client.savedForLater.posts.settings.enableOrUpdateAutomaticPosting(account, { ...params }) -> SettingEnableOrUpdateAutomaticPostingResponse

Settings

Types:

• SettingRetrieveResponse
• SettingCheckUsernameAvailabilityResponse
• SettingUpdateProfileResponse
• SettingUpdateSubscriptionPriceResponse

Methods:

• client.settings.retrieve(account) -> SettingRetrieveResponse
• client.settings.checkUsernameAvailability(account, { ...params }) -> SettingCheckUsernameAvailabilityResponse
• client.settings.updateProfile(account, { ...params }) -> SettingUpdateProfileResponse
• client.settings.updateSubscriptionPrice(account, { ...params }) -> SettingUpdateSubscriptionPriceResponse

BlockedCountries

Types:

• BlockedCountryRetrieveResponse
• BlockedCountryUpdateResponse

Methods:

• client.settings.blockedCountries.retrieve(account) -> BlockedCountryRetrieveResponse
• client.settings.blockedCountries.update(account, { ...params }) -> BlockedCountryUpdateResponse

WelcomeMessage

Types:

• WelcomeMessageRetrieveResponse
• WelcomeMessageUpdateResponse
• WelcomeMessageToggleResponse

Methods:

• client.settings.welcomeMessage.retrieve(account) -> WelcomeMessageRetrieveResponse
• client.settings.welcomeMessage.update(account, { ...params }) -> WelcomeMessageUpdateResponse
• client.settings.welcomeMessage.toggle(account, { ...params }) -> WelcomeMessageToggleResponse

SocialMediaButtons

Types:

• SocialMediaButtonUpdateResponse
• SocialMediaButtonListResponse
• SocialMediaButtonDeleteResponse
• SocialMediaButtonAddResponse
• SocialMediaButtonReorderResponse

Methods:

• client.settings.socialMediaButtons.update(buttonID, { ...params }) -> SocialMediaButtonUpdateResponse
• client.settings.socialMediaButtons.list(account) -> SocialMediaButtonListResponse
• client.settings.socialMediaButtons.delete(buttonID, { ...params }) -> SocialMediaButtonDeleteResponse
• client.settings.socialMediaButtons.add(account, { ...params }) -> SocialMediaButtonAddResponse
• client.settings.socialMediaButtons.reorder(account, { ...params }) -> SocialMediaButtonReorderResponse

SharedTrialLinks

Types:

• SharedTrialLinkListResponse
• SharedTrialLinkRevokeAccessResponse

Methods:

• client.sharedTrialLinks.list(account, { ...params }) -> SharedTrialLinkListResponse
• client.sharedTrialLinks.revokeAccess(sharedTrialLinkID, { ...params }) -> SharedTrialLinkRevokeAccessResponse

Tags

Types:

• TagListResponse
• TagAddResponse
• TagRemoveResponse

Methods:

• client.sharedTrialLinks.tags.list(sharedTrialLinkID, { ...params }) -> TagListResponse
• client.sharedTrialLinks.tags.add(sharedTrialLinkID, { ...params }) -> TagAddResponse
• client.sharedTrialLinks.tags.remove(sharedTrialLinkID, { ...params }) -> TagRemoveResponse

SharedTrackingLinks

Types:

• SharedTrackingLinkListResponse
• SharedTrackingLinkRevokeAccessResponse

Methods:

• client.sharedTrackingLinks.list(account, { ...params }) -> SharedTrackingLinkListResponse
• client.sharedTrackingLinks.revokeAccess(sharedTrackingLinkID, { ...params }) -> SharedTrackingLinkRevokeAccessResponse

Tags

Types:

• TagListResponse
• TagAddResponse
• TagRemoveResponse

Methods:

• client.sharedTrackingLinks.tags.list(sharedTrackingLinkID, { ...params }) -> TagListResponse
• client.sharedTrackingLinks.tags.add(sharedTrackingLinkID, { ...params }) -> TagAddResponse
• client.sharedTrackingLinks.tags.remove(sharedTrackingLinkID, { ...params }) -> TagRemoveResponse

SmartLinkPostbacks

Types:

• SmartLinkPostbackCreateResponse
• SmartLinkPostbackRetrieveResponse
• SmartLinkPostbackUpdateResponse
• SmartLinkPostbackListResponse
• SmartLinkPostbackDeleteResponse

Methods:

• client.smartLinkPostbacks.create({ ...params }) -> SmartLinkPostbackCreateResponse
• client.smartLinkPostbacks.retrieve(postbackID) -> SmartLinkPostbackRetrieveResponse
• client.smartLinkPostbacks.update(postbackID, { ...params }) -> SmartLinkPostbackUpdateResponse
• client.smartLinkPostbacks.list() -> SmartLinkPostbackListResponse
• client.smartLinkPostbacks.delete(postbackID) -> SmartLinkPostbackDeleteResponse | null

SmartLinks

Types:

• SmartLinkCreateResponse
• SmartLinkRetrieveResponse
• SmartLinkListResponse
• SmartLinkDeleteResponse
• SmartLinkListClicksResponse
• SmartLinkListConversionsResponse
• SmartLinkListFansResponse
• SmartLinkListSpendersResponse
• SmartLinkRetrieveStatsResponse

Methods:

• client.smartLinks.create({ ...params }) -> SmartLinkCreateResponse
• client.smartLinks.retrieve(smartLinkID) -> SmartLinkRetrieveResponse
• client.smartLinks.list({ ...params }) -> SmartLinkListResponse
• client.smartLinks.delete(smartLinkID) -> SmartLinkDeleteResponse
• client.smartLinks.listClicks(smartLinkID, { ...params }) -> SmartLinkListClicksResponse
• client.smartLinks.listConversions(smartLinkID, { ...params }) -> SmartLinkListConversionsResponse
• client.smartLinks.listFans(smartLinkID, { ...params }) -> SmartLinkListFansResponse
• client.smartLinks.listSpenders(smartLinkID, { ...params }) -> SmartLinkListSpendersResponse
• client.smartLinks.retrieveCohortArps(smartLinkID, { ...params }) -> void
• client.smartLinks.retrieveStats(smartLinkID, { ...params }) -> SmartLinkRetrieveStatsResponse

Statistics

Types:

• StatisticCalculateTotalTransactionsResponse
• StatisticGetOverviewResponse
• StatisticGetSubscriberMetricsResponse

Methods:

• client.statistics.calculateTotalTransactions(account, { ...params }) -> StatisticCalculateTotalTransactionsResponse
• client.statistics.getOverview(account, { ...params }) -> StatisticGetOverviewResponse
• client.statistics.getSubscriberMetrics(account, { ...params }) -> StatisticGetSubscriberMetricsResponse

Statements

Types:

• StatementGetEarningsResponse

Methods:

• client.statistics.statements.getEarnings(account, { ...params }) -> StatementGetEarningsResponse

Reach

Types:

• ReachGetProfileVisitorsResponse

Methods:

• client.statistics.reach.getProfileVisitors(account, { ...params }) -> ReachGetProfileVisitorsResponse

Subscribers

Types:

• SubscriberRetrieveStatisticsResponse

Methods:

• client.subscribers.retrieveStatistics(account, { ...params }) -> SubscriberRetrieveStatisticsResponse

Stored

Types:

• StoredListSharedTrackingLinksResponse
• StoredListSharedTrialLinksResponse
• StoredListTrackingLinksResponse
• StoredListTrialLinksResponse

Methods:

• client.stored.listSharedTrackingLinks(account, { ...params }) -> StoredListSharedTrackingLinksResponse
• client.stored.listSharedTrialLinks(account, { ...params }) -> StoredListSharedTrialLinksResponse
• client.stored.listTrackingLinks(account, { ...params }) -> StoredListTrackingLinksResponse
• client.stored.listTrialLinks(account, { ...params }) -> StoredListTrialLinksResponse

Stories

Types:

• StoryCreateResponse
• StoryRetrieveResponse
• StoryDeleteResponse
• StoryListActiveResponse
• StoryListArchiveResponse
• StoryListViewersResponse
• StoryMarkAsWatchedResponse
• StoryRetrieveStatsResponse

Methods:

• client.stories.create(account, { ...params }) -> StoryCreateResponse
• client.stories.retrieve(storyID, { ...params }) -> StoryRetrieveResponse
• client.stories.delete(storyID, { ...params }) -> StoryDeleteResponse
• client.stories.listActive(account) -> StoryListActiveResponse
• client.stories.listArchive(account, { ...params }) -> StoryListArchiveResponse
• client.stories.listViewers(storyID, { ...params }) -> StoryListViewersResponse
• client.stories.markAsWatched(storyID, { ...params }) -> StoryMarkAsWatchedResponse
• client.stories.retrieveStats(storyID, { ...params }) -> StoryRetrieveStatsResponse

Highlights

Types:

• HighlightCreateResponse
• HighlightRetrieveResponse
• HighlightUpdateResponse
• HighlightListResponse
• HighlightDeleteResponse
• HighlightAddStoryResponse
• HighlightRemoveStoryResponse

Methods:

• client.stories.highlights.create(account, { ...params }) -> HighlightCreateResponse
• client.stories.highlights.retrieve(highlightID, { ...params }) -> HighlightRetrieveResponse
• client.stories.highlights.update(highlightID, { ...params }) -> HighlightUpdateResponse
• client.stories.highlights.list(account, { ...params }) -> HighlightListResponse
• client.stories.highlights.delete(highlightID, { ...params }) -> HighlightDeleteResponse
• client.stories.highlights.addStory(storyID, { ...params }) -> HighlightAddStoryResponse
• client.stories.highlights.removeStory(storyID, { ...params }) -> HighlightRemoveStoryResponse

Bundles

Types:

• BundleCreateResponse
• BundleListResponse
• BundleDeleteResponse

Methods:

• client.bundles.create(account, { ...params }) -> BundleCreateResponse
• client.bundles.list(account) -> BundleListResponse
• client.bundles.delete(bundleID, { ...params }) -> BundleDeleteResponse

TrackingLinks

Types:

• TrackingLinkCreateResponse
• TrackingLinkRetrieveResponse
• TrackingLinkListResponse
• TrackingLinkDeleteResponse
• TrackingLinkGetStatsResponse
• TrackingLinkListSpendersResponse
• TrackingLinkListSubscribersResponse

Methods:

• client.trackingLinks.create(account, { ...params }) -> TrackingLinkCreateResponse
• client.trackingLinks.retrieve(trackingLinkID, { ...params }) -> TrackingLinkRetrieveResponse
• client.trackingLinks.list(account, { ...params }) -> TrackingLinkListResponse
• client.trackingLinks.delete(trackingLinkID, { ...params }) -> TrackingLinkDeleteResponse
• client.trackingLinks.getCohortArps(trackingLinkID, { ...params }) -> void
• client.trackingLinks.getStats(trackingLinkID, { ...params }) -> TrackingLinkGetStatsResponse
• client.trackingLinks.listSpenders(trackingLinkID, { ...params }) -> TrackingLinkListSpendersResponse
• client.trackingLinks.listSubscribers(trackingLinkID, { ...params }) -> TrackingLinkListSubscribersResponse

Tags

Types:

• TagListResponse
• TagAddResponse
• TagRemoveResponse

Methods:

• client.trackingLinks.tags.list(trackingLinkID, { ...params }) -> TagListResponse
• client.trackingLinks.tags.add(trackingLinkID, { ...params }) -> TagAddResponse
• client.trackingLinks.tags.remove(trackingLinkID, { ...params }) -> TagRemoveResponse

Transactions

Types:

• TransactionListResponse

Methods:

• client.transactions.list(account, { ...params }) -> TransactionListResponse

UserLists

Types:

• UserListCreateResponse
• UserListRetrieveResponse
• UserListUpdateResponse
• UserListListResponse
• UserListDeleteResponse

Methods:

• client.userLists.create(account, { ...params }) -> UserListCreateResponse
• client.userLists.retrieve(userListID, { ...params }) -> UserListRetrieveResponse
• client.userLists.update(userListID, { ...params }) -> UserListUpdateResponse
• client.userLists.list(account, { ...params }) -> UserListListResponse
• client.userLists.delete(userListID, { ...params }) -> UserListDeleteResponse

Users

Types:

• UserListResponse
• UserAddResponse
• UserClearResponse
• UserListPinnedResponse
• UserPinResponse
• UserRemoveResponse

Methods:

• client.userLists.users.list(userListID, { ...params }) -> UserListResponse
• client.userLists.users.add(userListID, { ...params }) -> UserAddResponse
• client.userLists.users.clear(userListID, { ...params }) -> UserClearResponse
• client.userLists.users.listPinned(userListID, { ...params }) -> UserListPinnedResponse
• client.userLists.users.pin(userID, { ...params }) -> UserPinResponse
• client.userLists.users.remove(userID, { ...params }) -> UserRemoveResponse

Users

Types:

• UserRetrieveResponse
• UserListResponse

Methods:

• client.users.retrieve(username, { ...params }) -> UserRetrieveResponse
• client.users.list(account, { ...params }) -> UserListResponse

Restrict

Types:

• RestrictCreateResponse
• RestrictDeleteResponse

Methods:

• client.users.restrict.create(userID, { ...params }) -> RestrictCreateResponse
• client.users.restrict.delete(userID, { ...params }) -> RestrictDeleteResponse

Block

Types:

• BlockCreateResponse
• BlockDeleteResponse

Methods:

• client.users.block.create(userID, { ...params }) -> BlockCreateResponse
• client.users.block.delete(userID, { ...params }) -> BlockDeleteResponse

Subscribe

Types:

• SubscribeCreateResponse
• SubscribeDeleteResponse

Methods:

• client.users.subscribe.create(userID, { ...params }) -> SubscribeCreateResponse
• client.users.subscribe.delete(userID, { ...params }) -> SubscribeDeleteResponse

Webhooks

Types:

• WebhookCreateResponse
• WebhookRetrieveResponse
• WebhookUpdateResponse
• WebhookListResponse
• WebhookDeleteResponse
• WebhookListEventsResponse

Methods:

• client.webhooks.create({ ...params }) -> WebhookCreateResponse
• client.webhooks.retrieve(webhookID) -> WebhookRetrieveResponse
• client.webhooks.update(webhookID, { ...params }) -> WebhookUpdateResponse
• client.webhooks.list() -> WebhookListResponse
• client.webhooks.delete(webhookID) -> WebhookDeleteResponse | null
• client.webhooks.listEvents() -> WebhookListEventsResponse