omnivore/packages/api/api.md

yarn run v1.22.18 $ /Users/jacksonh/src/omnivore/node_modules/.bin/graphql-markdown src/generated/schema.graphql

Schema Types

Table of Contents

• Query
• Mutation
• Objects
  • AddPopularReadError
  • AddPopularReadSuccess
  • ApiKey
  • ApiKeysError
  • ApiKeysSuccess
  • ArchiveLinkError
  • ArchiveLinkSuccess
  • Article
  • ArticleEdge
  • ArticleError
  • ArticleSavingRequest
  • ArticleSavingRequestError
  • ArticleSavingRequestSuccess
  • ArticleSuccess
  • ArticlesError
  • ArticlesSuccess
  • CreateArticleError
  • CreateArticleSavingRequestError
  • CreateArticleSavingRequestSuccess
  • CreateArticleSuccess
  • CreateHighlightError
  • CreateHighlightReplyError
  • CreateHighlightReplySuccess
  • CreateHighlightSuccess
  • CreateLabelError
  • CreateLabelSuccess
  • CreateNewsletterEmailError
  • CreateNewsletterEmailSuccess
  • CreateReactionError
  • CreateReactionSuccess
  • CreateReminderError
  • CreateReminderSuccess
  • DeleteHighlightError
  • DeleteHighlightReplyError
  • DeleteHighlightReplySuccess
  • DeleteHighlightSuccess
  • DeleteLabelError
  • DeleteLabelSuccess
  • DeleteNewsletterEmailError
  • DeleteNewsletterEmailSuccess
  • DeleteReactionError
  • DeleteReactionSuccess
  • DeleteReminderError
  • DeleteReminderSuccess
  • DeleteWebhookError
  • DeleteWebhookSuccess
  • DeviceToken
  • FeedArticle
  • FeedArticleEdge
  • FeedArticlesError
  • FeedArticlesSuccess
  • GenerateApiKeyError
  • GenerateApiKeySuccess
  • GetFollowersError
  • GetFollowersSuccess
  • GetFollowingError
  • GetFollowingSuccess
  • GetUserPersonalizationError
  • GetUserPersonalizationSuccess
  • GoogleSignupError
  • GoogleSignupSuccess
  • Highlight
  • HighlightReply
  • HighlightStats
  • Label
  • LabelsError
  • LabelsSuccess
  • Link
  • LinkShareInfo
  • LogOutError
  • LogOutSuccess
  • LoginError
  • LoginSuccess
  • MergeHighlightError
  • MergeHighlightSuccess
  • NewsletterEmail
  • NewsletterEmailsError
  • NewsletterEmailsSuccess
  • Page
  • PageInfo
  • Profile
  • Reaction
  • ReadState
  • Reminder
  • ReminderError
  • ReminderSuccess
  • ReportItemResult
  • RevokeApiKeyError
  • RevokeApiKeySuccess
  • SaveArticleReadingProgressError
  • SaveArticleReadingProgressSuccess
  • SaveError
  • SaveSuccess
  • SearchError
  • SearchItem
  • SearchItemEdge
  • SearchSuccess
  • SendInstallInstructionsError
  • SendInstallInstructionsSuccess
  • SetBookmarkArticleError
  • SetBookmarkArticleSuccess
  • SetDeviceTokenError
  • SetDeviceTokenSuccess
  • SetFollowError
  • SetFollowSuccess
  • SetLabelsError
  • SetLabelsSuccess
  • SetShareArticleError
  • SetShareArticleSuccess
  • SetShareHighlightError
  • SetShareHighlightSuccess
  • SetUserPersonalizationError
  • SetUserPersonalizationSuccess
  • SetWebhookError
  • SetWebhookSuccess
  • ShareStats
  • SharedArticleError
  • SharedArticleSuccess
  • SignupError
  • SignupSuccess
  • SubscribeError
  • SubscribeSuccess
  • Subscription
  • SubscriptionsError
  • SubscriptionsSuccess
  • UnsubscribeError
  • UnsubscribeSuccess
  • UpdateHighlightError
  • UpdateHighlightReplyError
  • UpdateHighlightReplySuccess
  • UpdateHighlightSuccess
  • UpdateLabelError
  • UpdateLabelSuccess
  • UpdateLinkShareInfoError
  • UpdateLinkShareInfoSuccess
  • UpdatePageError
  • UpdatePageSuccess
  • UpdateReminderError
  • UpdateReminderSuccess
  • UpdateSharedCommentError
  • UpdateSharedCommentSuccess
  • UpdateUserError
  • UpdateUserProfileError
  • UpdateUserProfileSuccess
  • UpdateUserSuccess
  • UploadFileRequestError
  • UploadFileRequestSuccess
  • User
  • UserError
  • UserPersonalization
  • UserSuccess
  • UsersError
  • UsersSuccess
  • Webhook
  • WebhookError
  • WebhookSuccess
  • WebhooksError
  • WebhooksSuccess
• Inputs
  • ArchiveLinkInput
  • ArticleHighlightsInput
  • CreateArticleInput
  • CreateArticleSavingRequestInput
  • CreateHighlightInput
  • CreateHighlightReplyInput
  • CreateLabelInput
  • CreateReactionInput
  • CreateReminderInput
  • GenerateApiKeyInput
  • GoogleLoginInput
  • GoogleSignupInput
  • LoginInput
  • MergeHighlightInput
  • PageInfoInput
  • PreparedDocumentInput
  • ReportItemInput
  • SaveArticleReadingProgressInput
  • SaveFileInput
  • SavePageInput
  • SaveUrlInput
  • SetBookmarkArticleInput
  • SetDeviceTokenInput
  • SetFollowInput
  • SetLabelsForHighlightInput
  • SetLabelsInput
  • SetShareArticleInput
  • SetShareHighlightInput
  • SetUserPersonalizationInput
  • SetWebhookInput
  • SignupInput
  • SortParams
  • UpdateHighlightInput
  • UpdateHighlightReplyInput
  • UpdateLabelInput
  • UpdateLinkShareInfoInput
  • UpdatePageInput
  • UpdateReminderInput
  • UpdateSharedCommentInput
  • UpdateUserInput
  • UpdateUserProfileInput
  • UploadFileRequestInput
• Enums
  • AddPopularReadErrorCode
  • ApiKeysErrorCode
  • ArchiveLinkErrorCode
  • ArticleErrorCode
  • ArticleSavingRequestErrorCode
  • ArticleSavingRequestStatus
  • ArticlesErrorCode
  • ContentReader
  • CreateArticleErrorCode
  • CreateArticleSavingRequestErrorCode
  • CreateHighlightErrorCode
  • CreateHighlightReplyErrorCode
  • CreateLabelErrorCode
  • CreateNewsletterEmailErrorCode
  • CreateReactionErrorCode
  • CreateReminderErrorCode
  • DeleteHighlightErrorCode
  • DeleteHighlightReplyErrorCode
  • DeleteLabelErrorCode
  • DeleteNewsletterEmailErrorCode
  • DeleteReactionErrorCode
  • DeleteReminderErrorCode
  • DeleteWebhookErrorCode
  • FeedArticlesErrorCode
  • GenerateApiKeyErrorCode
  • GetFollowersErrorCode
  • GetFollowingErrorCode
  • GetUserPersonalizationErrorCode
  • LabelsErrorCode
  • LogOutErrorCode
  • LoginErrorCode
  • MergeHighlightErrorCode
  • NewsletterEmailsErrorCode
  • PageType
  • ReactionType
  • ReminderErrorCode
  • ReportType
  • RevokeApiKeyErrorCode
  • SaveArticleReadingProgressErrorCode
  • SaveErrorCode
  • SearchErrorCode
  • SendInstallInstructionsErrorCode
  • SetBookmarkArticleErrorCode
  • SetDeviceTokenErrorCode
  • SetFollowErrorCode
  • SetLabelsErrorCode
  • SetShareArticleErrorCode
  • SetShareHighlightErrorCode
  • SetUserPersonalizationErrorCode
  • SetWebhookErrorCode
  • SharedArticleErrorCode
  • SignupErrorCode
  • SortBy
  • SortOrder
  • SubscribeErrorCode
  • SubscriptionStatus
  • SubscriptionsErrorCode
  • UnsubscribeErrorCode
  • UpdateHighlightErrorCode
  • UpdateHighlightReplyErrorCode
  • UpdateLabelErrorCode
  • UpdateLinkShareInfoErrorCode
  • UpdatePageErrorCode
  • UpdateReminderErrorCode
  • UpdateSharedCommentErrorCode
  • UpdateUserErrorCode
  • UpdateUserProfileErrorCode
  • UploadFileRequestErrorCode
  • UploadFileStatus
  • UserErrorCode
  • UsersErrorCode
  • WebhookErrorCode
  • WebhookEvent
  • WebhooksErrorCode
• Scalars
  • Boolean
  • Date
  • Float
  • ID
  • Int
  • String
• Unions
  • AddPopularReadResult
  • ApiKeysResult
  • ArchiveLinkResult
  • ArticleResult
  • ArticleSavingRequestResult
  • ArticlesResult
  • CreateArticleResult
  • CreateArticleSavingRequestResult
  • CreateHighlightReplyResult
  • CreateHighlightResult
  • CreateLabelResult
  • CreateNewsletterEmailResult
  • CreateReactionResult
  • CreateReminderResult
  • DeleteHighlightReplyResult
  • DeleteHighlightResult
  • DeleteLabelResult
  • DeleteNewsletterEmailResult
  • DeleteReactionResult
  • DeleteReminderResult
  • DeleteWebhookResult
  • FeedArticlesResult
  • GenerateApiKeyResult
  • GetFollowersResult
  • GetFollowingResult
  • GetUserPersonalizationResult
  • GoogleSignupResult
  • LabelsResult
  • LogOutResult
  • LoginResult
  • MergeHighlightResult
  • NewsletterEmailsResult
  • ReminderResult
  • RevokeApiKeyResult
  • SaveArticleReadingProgressResult
  • SaveResult
  • SearchResult
  • SendInstallInstructionsResult
  • SetBookmarkArticleResult
  • SetDeviceTokenResult
  • SetFollowResult
  • SetLabelsResult
  • SetShareArticleResult
  • SetShareHighlightResult
  • SetUserPersonalizationResult
  • SetWebhookResult
  • SharedArticleResult
  • SignupResult
  • SubscribeResult
  • SubscriptionsResult
  • UnsubscribeResult
  • UpdateHighlightReplyResult
  • UpdateHighlightResult
  • UpdateLabelResult
  • UpdateLinkShareInfoResult
  • UpdatePageResult
  • UpdateReminderResult
  • UpdateSharedCommentResult
  • UpdateUserProfileResult
  • UpdateUserResult
  • UploadFileRequestResult
  • UserResult
  • UsersResult
  • WebhookResult
  • WebhooksResult

Query

Field	Argument	Type	Description
apiKeys		ApiKeysResult!
article		ArticleResult!
slug		String!
username		String!
articleSavingRequest		ArticleSavingRequestResult!
id		ID!
articles		ArticlesResult!
after		String
first		Int
includePending		Boolean
query		String
sharedOnly		Boolean
sort		SortParams
feedArticles		FeedArticlesResult!
after		String
first		Int
sharedByUser		ID
sort		SortParams
getFollowers		GetFollowersResult!
userId		ID
getFollowing		GetFollowingResult!
userId		ID
getUserPersonalization		GetUserPersonalizationResult!
hello		String
labels		LabelsResult!
me		User
newsletterEmails		NewsletterEmailsResult!
reminder		ReminderResult!
linkId		ID!
search		SearchResult!
after		String
first		Int
query		String
sendInstallInstructions		SendInstallInstructionsResult!
sharedArticle		SharedArticleResult!
selectedHighlightId		String
slug		String!
username		String!
subscriptions		SubscriptionsResult!
sort		SortParams
user		UserResult!
userId		ID
username		String
users		UsersResult!
validateUsername		Boolean!
username		String!
webhook		WebhookResult!
id		ID!
webhooks		WebhooksResult!

Mutation

Field	Argument	Type	Description
addPopularRead		AddPopularReadResult!
name		String!
createArticle		CreateArticleResult!
input		CreateArticleInput!
createArticleSavingRequest		CreateArticleSavingRequestResult!
input		CreateArticleSavingRequestInput!
createHighlight		CreateHighlightResult!
input		CreateHighlightInput!
createHighlightReply		CreateHighlightReplyResult!
input		CreateHighlightReplyInput!
createLabel		CreateLabelResult!
input		CreateLabelInput!
createNewsletterEmail		CreateNewsletterEmailResult!
createReaction		CreateReactionResult!
input		CreateReactionInput!
createReminder		CreateReminderResult!
input		CreateReminderInput!
deleteHighlight		DeleteHighlightResult!
highlightId		ID!
deleteHighlightReply		DeleteHighlightReplyResult!
highlightReplyId		ID!
deleteLabel		DeleteLabelResult!
id		ID!
deleteNewsletterEmail		DeleteNewsletterEmailResult!
newsletterEmailId		ID!
deleteReaction		DeleteReactionResult!
id		ID!
deleteReminder		DeleteReminderResult!
id		ID!
deleteWebhook		DeleteWebhookResult!
id		ID!
generateApiKey		GenerateApiKeyResult!
input		GenerateApiKeyInput!
googleLogin		LoginResult!
input		GoogleLoginInput!
googleSignup		GoogleSignupResult!
input		GoogleSignupInput!
logOut		LogOutResult!
login		LoginResult!
input		LoginInput!
mergeHighlight		MergeHighlightResult!
input		MergeHighlightInput!
reportItem		ReportItemResult!
input		ReportItemInput!
revokeApiKey		RevokeApiKeyResult!
id		ID!
saveArticleReadingProgress		SaveArticleReadingProgressResult!
input		SaveArticleReadingProgressInput!
saveFile		SaveResult!
input		SaveFileInput!
savePage		SaveResult!
input		SavePageInput!
saveUrl		SaveResult!
input		SaveUrlInput!
setBookmarkArticle		SetBookmarkArticleResult!
input		SetBookmarkArticleInput!
setDeviceToken		SetDeviceTokenResult!
input		SetDeviceTokenInput!
setFollow		SetFollowResult!
input		SetFollowInput!
setLabels		SetLabelsResult!
input		SetLabelsInput!
setLabelsForHighlight		SetLabelsResult!
input		SetLabelsForHighlightInput!
setLinkArchived		ArchiveLinkResult!
input		ArchiveLinkInput!
setShareArticle		SetShareArticleResult!
input		SetShareArticleInput!
setShareHighlight		SetShareHighlightResult!
input		SetShareHighlightInput!
setUserPersonalization		SetUserPersonalizationResult!
input		SetUserPersonalizationInput!
setWebhook		SetWebhookResult!
input		SetWebhookInput!
signup		SignupResult!
input		SignupInput!
subscribe		SubscribeResult!
name		String!
unsubscribe		UnsubscribeResult!
name		String!
updateHighlight		UpdateHighlightResult!
input		UpdateHighlightInput!
updateHighlightReply		UpdateHighlightReplyResult!
input		UpdateHighlightReplyInput!
updateLabel		UpdateLabelResult!
input		UpdateLabelInput!
updateLinkShareInfo		UpdateLinkShareInfoResult!
input		UpdateLinkShareInfoInput!
updatePage		UpdatePageResult!
input		UpdatePageInput!
updateReminder		UpdateReminderResult!
input		UpdateReminderInput!
updateSharedComment		UpdateSharedCommentResult!
input		UpdateSharedCommentInput!
updateUser		UpdateUserResult!
input		UpdateUserInput!
updateUserProfile		UpdateUserProfileResult!
input		UpdateUserProfileInput!
uploadFileRequest		UploadFileRequestResult!
input		UploadFileRequestInput!

Objects

AddPopularReadError

Field	Argument	Type	Description
errorCodes		[AddPopularReadErrorCode!]!

AddPopularReadSuccess

Field	Argument	Type	Description
pageId		String!

ApiKey

Field	Argument	Type	Description
createdAt		Date!
expiresAt		Date!
id		ID!
key		String
name		String!
scopes		[String!]
usedAt		Date

ApiKeysError

Field	Argument	Type	Description
errorCodes		[ApiKeysErrorCode!]!

ApiKeysSuccess

Field	Argument	Type	Description
apiKeys		[ApiKey!]!

ArchiveLinkError

Field	Argument	Type	Description
errorCodes		[ArchiveLinkErrorCode!]!
message		String!

ArchiveLinkSuccess

Field	Argument	Type	Description
linkId		String!
message		String!

Article

Field	Argument	Type	Description
author		String
content		String!
contentReader		ContentReader!
createdAt		Date!
description		String
hasContent		Boolean
hash		String!
highlights		[Highlight!]!
input		ArticleHighlightsInput
id		ID!
image		String
isArchived		Boolean!
labels		[Label!]
language		String
linkId		ID
originalArticleUrl		String
originalHtml		String
pageType		PageType
postedByViewer		Boolean
publishedAt		Date
readAt		Date
readingProgressAnchorIndex		Int!
readingProgressPercent		Float!
savedAt		Date!
savedByViewer		Boolean
shareInfo		LinkShareInfo
sharedComment		String
siteIcon		String
siteName		String
slug		String!
state		ArticleSavingRequestStatus
subscription		String
title		String!
unsubHttpUrl		String
unsubMailTo		String
updatedAt		Date!
uploadFileId		ID
url		String!

ArticleEdge

Field	Argument	Type	Description
cursor		String!
node		Article!

ArticleError

Field	Argument	Type	Description
errorCodes		[ArticleErrorCode!]!

ArticleSavingRequest

Field	Argument	Type	Description
article ⚠️		Article	⚠️ DEPRECATED article has been replaced with slug
createdAt		Date!
errorCode		CreateArticleErrorCode
id		ID!
slug		String!
status		ArticleSavingRequestStatus!
updatedAt		Date!
user		User!
userId ⚠️		ID!	⚠️ DEPRECATED userId has been replaced with user

ArticleSavingRequestError

Field	Argument	Type	Description
errorCodes		[ArticleSavingRequestErrorCode!]!

ArticleSavingRequestSuccess

Field	Argument	Type	Description
articleSavingRequest		ArticleSavingRequest!

ArticleSuccess

Field	Argument	Type	Description
article		Article!

ArticlesError

Field	Argument	Type	Description
errorCodes		[ArticlesErrorCode!]!

ArticlesSuccess

Field	Argument	Type	Description
edges		[ArticleEdge!]!
pageInfo		PageInfo!

CreateArticleError

Field	Argument	Type	Description
errorCodes		[CreateArticleErrorCode!]!

CreateArticleSavingRequestError

Field	Argument	Type	Description
errorCodes		[CreateArticleSavingRequestErrorCode!]!

CreateArticleSavingRequestSuccess

Field	Argument	Type	Description
articleSavingRequest		ArticleSavingRequest!

CreateArticleSuccess

Field	Argument	Type	Description
created		Boolean!
createdArticle		Article!
user		User!

CreateHighlightError

Field	Argument	Type	Description
errorCodes		[CreateHighlightErrorCode!]!

CreateHighlightReplyError

Field	Argument	Type	Description
errorCodes		[CreateHighlightReplyErrorCode!]!

CreateHighlightReplySuccess

Field	Argument	Type	Description
highlightReply		HighlightReply!

CreateHighlightSuccess

Field	Argument	Type	Description
highlight		Highlight!

CreateLabelError

Field	Argument	Type	Description
errorCodes		[CreateLabelErrorCode!]!

CreateLabelSuccess

Field	Argument	Type	Description
label		Label!

CreateNewsletterEmailError

Field	Argument	Type	Description
errorCodes		[CreateNewsletterEmailErrorCode!]!

CreateNewsletterEmailSuccess

Field	Argument	Type	Description
newsletterEmail		NewsletterEmail!

CreateReactionError

Field	Argument	Type	Description
errorCodes		[CreateReactionErrorCode!]!

CreateReactionSuccess

Field	Argument	Type	Description
reaction		Reaction!

CreateReminderError

Field	Argument	Type	Description
errorCodes		[CreateReminderErrorCode!]!

CreateReminderSuccess

Field	Argument	Type	Description
reminder		Reminder!

DeleteHighlightError

Field	Argument	Type	Description
errorCodes		[DeleteHighlightErrorCode!]!

DeleteHighlightReplyError

Field	Argument	Type	Description
errorCodes		[DeleteHighlightReplyErrorCode!]!

DeleteHighlightReplySuccess

Field	Argument	Type	Description
highlightReply		HighlightReply!

DeleteHighlightSuccess

Field	Argument	Type	Description
highlight		Highlight!

DeleteLabelError

Field	Argument	Type	Description
errorCodes		[DeleteLabelErrorCode!]!

DeleteLabelSuccess

Field	Argument	Type	Description
label		Label!

DeleteNewsletterEmailError

Field	Argument	Type	Description
errorCodes		[DeleteNewsletterEmailErrorCode!]!

DeleteNewsletterEmailSuccess

Field	Argument	Type	Description
newsletterEmail		NewsletterEmail!

DeleteReactionError

Field	Argument	Type	Description
errorCodes		[DeleteReactionErrorCode!]!

DeleteReactionSuccess

Field	Argument	Type	Description
reaction		Reaction!

DeleteReminderError

Field	Argument	Type	Description
errorCodes		[DeleteReminderErrorCode!]!

DeleteReminderSuccess

Field	Argument	Type	Description
reminder		Reminder!

DeleteWebhookError

Field	Argument	Type	Description
errorCodes		[DeleteWebhookErrorCode!]!

DeleteWebhookSuccess

Field	Argument	Type	Description
webhook		Webhook!

DeviceToken

Field	Argument	Type	Description
createdAt		Date!
id		ID!
token		String!

FeedArticle

Field	Argument	Type	Description
annotationsCount		Int
article		Article!
highlight		Highlight
highlightsCount		Int
id		ID!
reactions		[Reaction!]!
sharedAt		Date!
sharedBy		User!
sharedComment		String
sharedWithHighlights		Boolean

FeedArticleEdge

Field	Argument	Type	Description
cursor		String!
node		FeedArticle!

FeedArticlesError

Field	Argument	Type	Description
errorCodes		[FeedArticlesErrorCode!]!

FeedArticlesSuccess

Field	Argument	Type	Description
edges		[FeedArticleEdge!]!
pageInfo		PageInfo!

GenerateApiKeyError

Field	Argument	Type	Description
errorCodes		[GenerateApiKeyErrorCode!]!

GenerateApiKeySuccess

Field	Argument	Type	Description
apiKey		ApiKey!

GetFollowersError

Field	Argument	Type	Description
errorCodes		[GetFollowersErrorCode!]!

GetFollowersSuccess

Field	Argument	Type	Description
followers		[User!]!

GetFollowingError

Field	Argument	Type	Description
errorCodes		[GetFollowingErrorCode!]!

GetFollowingSuccess

Field	Argument	Type	Description
following		[User!]!

GetUserPersonalizationError

Field	Argument	Type	Description
errorCodes		[GetUserPersonalizationErrorCode!]!

GetUserPersonalizationSuccess

Field	Argument	Type	Description
userPersonalization		UserPersonalization

GoogleSignupError

Field	Argument	Type	Description
errorCodes		[SignupErrorCode]!

GoogleSignupSuccess

Field	Argument	Type	Description
me		User!

Highlight

Field	Argument	Type	Description
annotation		String
createdAt		Date!
createdByMe		Boolean!
id		ID!
patch		String!
prefix		String
quote		String!
reactions		[Reaction!]!
replies		[HighlightReply!]!
sharedAt		Date
shortId		String!
suffix		String
updatedAt		Date!
user		User!

HighlightReply

Field	Argument	Type	Description
createdAt		Date!
highlight		Highlight!
id		ID!
text		String!
updatedAt		Date!
user		User!

HighlightStats

Field	Argument	Type	Description
highlightCount		Int!

Label

Field	Argument	Type	Description
color		String!
createdAt		Date
description		String
id		ID!
name		String!

LabelsError

Field	Argument	Type	Description
errorCodes		[LabelsErrorCode!]!

LabelsSuccess

Field	Argument	Type	Description
labels		[Label!]!

Link

Field	Argument	Type	Description
highlightStats		HighlightStats!
id		ID!
page		Page!
postedByViewer		Boolean!
readState		ReadState!
savedAt		Date!
savedBy		User!
savedByViewer		Boolean!
shareInfo		LinkShareInfo!
shareStats		ShareStats!
slug		String!
updatedAt		Date!
url		String!

LinkShareInfo

Field	Argument	Type	Description
description		String!
imageUrl		String!
title		String!

LogOutError

Field	Argument	Type	Description
errorCodes		[LogOutErrorCode!]!

LogOutSuccess

Field	Argument	Type	Description
message		String

LoginError

Field	Argument	Type	Description
errorCodes		[LoginErrorCode!]!

LoginSuccess

Field	Argument	Type	Description
me		User!

MergeHighlightError

Field	Argument	Type	Description
errorCodes		[MergeHighlightErrorCode!]!

MergeHighlightSuccess

Field	Argument	Type	Description
highlight		Highlight!
overlapHighlightIdList		[String!]!

NewsletterEmail

Field	Argument	Type	Description
address		String!
confirmationCode		String
id		ID!

NewsletterEmailsError

Field	Argument	Type	Description
errorCodes		[NewsletterEmailsErrorCode!]!

NewsletterEmailsSuccess

Field	Argument	Type	Description
newsletterEmails		[NewsletterEmail!]!

Page

Field	Argument	Type	Description
author		String
createdAt		Date!
description		String
hash		String!
id		ID!
image		String!
originalHtml		String!
originalUrl		String!
publishedAt		Date
readableHtml		String!
title		String!
type		PageType!
updatedAt		Date!
url		String!

PageInfo

Field	Argument	Type	Description
endCursor		String
hasNextPage		Boolean!
hasPreviousPage		Boolean!
startCursor		String
totalCount		Int

Profile

Field	Argument	Type	Description
bio		String
id		ID!
pictureUrl		String
private		Boolean!
username		String!

Reaction

Field	Argument	Type	Description
code		ReactionType!
createdAt		Date!
id		ID!
updatedAt		Date
user		User!

ReadState

Field	Argument	Type	Description
progressAnchorIndex		Int!
progressPercent		Float!
reading		Boolean
readingTime		Int

Reminder

Field	Argument	Type	Description
archiveUntil		Boolean!
id		ID!
remindAt		Date!
sendNotification		Boolean!

ReminderError

Field	Argument	Type	Description
errorCodes		[ReminderErrorCode!]!

ReminderSuccess

Field	Argument	Type	Description
reminder		Reminder!

ReportItemResult

Field	Argument	Type	Description
message		String!

RevokeApiKeyError

Field	Argument	Type	Description
errorCodes		[RevokeApiKeyErrorCode!]!

RevokeApiKeySuccess

Field	Argument	Type	Description
apiKey		ApiKey!

SaveArticleReadingProgressError

Field	Argument	Type	Description
errorCodes		[SaveArticleReadingProgressErrorCode!]!

SaveArticleReadingProgressSuccess

Field	Argument	Type	Description
updatedArticle		Article!

SaveError

Field	Argument	Type	Description
errorCodes		[SaveErrorCode!]!
message		String

SaveSuccess

Field	Argument	Type	Description
clientRequestId		ID!
url		String!

SearchError

Field	Argument	Type	Description
errorCodes		[SearchErrorCode!]!

SearchItem

Field	Argument	Type	Description
annotation		String
author		String
contentReader		ContentReader!
createdAt		Date!
description		String
highlights		[Highlight!]
id		ID!
image		String
isArchived		Boolean!
labels		[Label!]
language		String
originalArticleUrl		String
ownedByViewer		Boolean
pageId		ID
pageType		PageType!
publishedAt		Date
quote		String
readAt		Date
readingProgressAnchorIndex		Int!
readingProgressPercent		Float!
savedAt		Date!
shortId		String
siteName		String
slug		String!
state		ArticleSavingRequestStatus
subscription		String
title		String!
unsubHttpUrl		String
unsubMailTo		String
updatedAt		Date
uploadFileId		ID
url		String!

SearchItemEdge

Field	Argument	Type	Description
cursor		String!
node		SearchItem!

SearchSuccess

Field	Argument	Type	Description
edges		[SearchItemEdge!]!
pageInfo		PageInfo!

SendInstallInstructionsError

Field	Argument	Type	Description
errorCodes		[SendInstallInstructionsErrorCode!]!

SendInstallInstructionsSuccess

Field	Argument	Type	Description
sent		Boolean!

SetBookmarkArticleError

Field	Argument	Type	Description
errorCodes		[SetBookmarkArticleErrorCode!]!

SetBookmarkArticleSuccess

Field	Argument	Type	Description
bookmarkedArticle		Article!

SetDeviceTokenError

Field	Argument	Type	Description
errorCodes		[SetDeviceTokenErrorCode!]!

SetDeviceTokenSuccess

Field	Argument	Type	Description
deviceToken		DeviceToken!

SetFollowError

Field	Argument	Type	Description
errorCodes		[SetFollowErrorCode!]!

SetFollowSuccess

Field	Argument	Type	Description
updatedUser		User!

SetLabelsError

Field	Argument	Type	Description
errorCodes		[SetLabelsErrorCode!]!

SetLabelsSuccess

Field	Argument	Type	Description
labels		[Label!]!

SetShareArticleError

Field	Argument	Type	Description
errorCodes		[SetShareArticleErrorCode!]!

SetShareArticleSuccess

Field	Argument	Type	Description
updatedArticle		Article!
updatedFeedArticle		FeedArticle
updatedFeedArticleId		String

SetShareHighlightError

Field	Argument	Type	Description
errorCodes		[SetShareHighlightErrorCode!]!

SetShareHighlightSuccess

Field	Argument	Type	Description
highlight		Highlight!

SetUserPersonalizationError

Field	Argument	Type	Description
errorCodes		[SetUserPersonalizationErrorCode!]!

SetUserPersonalizationSuccess

Field	Argument	Type	Description
updatedUserPersonalization		UserPersonalization!

SetWebhookError

Field	Argument	Type	Description
errorCodes		[SetWebhookErrorCode!]!

SetWebhookSuccess

Field	Argument	Type	Description
webhook		Webhook!

ShareStats

Field	Argument	Type	Description
readDuration		Int!
saveCount		Int!
viewCount		Int!

SharedArticleError

Field	Argument	Type	Description
errorCodes		[SharedArticleErrorCode!]!

SharedArticleSuccess

Field	Argument	Type	Description
article		Article!

SignupError

Field	Argument	Type	Description
errorCodes		[SignupErrorCode]!

SignupSuccess

Field	Argument	Type	Description
me		User!

SubscribeError

Field	Argument	Type	Description
errorCodes		[SubscribeErrorCode!]!

SubscribeSuccess

Field	Argument	Type	Description
subscriptions		[Subscription!]!

Subscription

Field	Argument	Type	Description
createdAt		Date!
description		String
id		ID!
name		String!
newsletterEmail		String!
status		SubscriptionStatus!
unsubscribeHttpUrl		String
unsubscribeMailTo		String
updatedAt		Date!
url		String

SubscriptionsError

Field	Argument	Type	Description
errorCodes		[SubscriptionsErrorCode!]!

SubscriptionsSuccess

Field	Argument	Type	Description
subscriptions		[Subscription!]!

UnsubscribeError

Field	Argument	Type	Description
errorCodes		[UnsubscribeErrorCode!]!

UnsubscribeSuccess

Field	Argument	Type	Description
subscription		Subscription!

UpdateHighlightError

Field	Argument	Type	Description
errorCodes		[UpdateHighlightErrorCode!]!

UpdateHighlightReplyError

Field	Argument	Type	Description
errorCodes		[UpdateHighlightReplyErrorCode!]!

UpdateHighlightReplySuccess

Field	Argument	Type	Description
highlightReply		HighlightReply!

UpdateHighlightSuccess

Field	Argument	Type	Description
highlight		Highlight!

UpdateLabelError

Field	Argument	Type	Description
errorCodes		[UpdateLabelErrorCode!]!

UpdateLabelSuccess

Field	Argument	Type	Description
label		Label!

UpdateLinkShareInfoError

Field	Argument	Type	Description
errorCodes		[UpdateLinkShareInfoErrorCode!]!

UpdateLinkShareInfoSuccess

Field	Argument	Type	Description
message		String!

UpdatePageError

Field	Argument	Type	Description
errorCodes		[UpdatePageErrorCode!]!

UpdatePageSuccess

Field	Argument	Type	Description
updatedPage		Article!

UpdateReminderError

Field	Argument	Type	Description
errorCodes		[UpdateReminderErrorCode!]!

UpdateReminderSuccess

Field	Argument	Type	Description
reminder		Reminder!

UpdateSharedCommentError

Field	Argument	Type	Description
errorCodes		[UpdateSharedCommentErrorCode!]!

UpdateSharedCommentSuccess

Field	Argument	Type	Description
articleID		ID!
sharedComment		String!

UpdateUserError

Field	Argument	Type	Description
errorCodes		[UpdateUserErrorCode!]!

UpdateUserProfileError

Field	Argument	Type	Description
errorCodes		[UpdateUserProfileErrorCode!]!

UpdateUserProfileSuccess

Field	Argument	Type	Description
user		User!

UpdateUserSuccess

Field	Argument	Type	Description
user		User!

UploadFileRequestError

Field	Argument	Type	Description
errorCodes		[UploadFileRequestErrorCode!]!

UploadFileRequestSuccess

Field	Argument	Type	Description
createdPageId		String
id		ID!
uploadFileId		ID
uploadSignedUrl		String

User

Field	Argument	Type	Description
followersCount		Int
friendsCount		Int
id		ID!
isFriend ⚠️		Boolean	⚠️ DEPRECATED isFriend has been replaced with viewerIsFollowing
isFullUser		Boolean
name		String!
picture		String
profile		Profile!
sharedArticles		[FeedArticle!]!
sharedArticlesCount		Int
sharedHighlightsCount		Int
sharedNotesCount		Int
viewerIsFollowing		Boolean

UserError

Field	Argument	Type	Description
errorCodes		[UserErrorCode!]!

UserPersonalization

Field	Argument	Type	Description
fontFamily		String
fontSize		Int
id		ID
libraryLayoutType		String
librarySortOrder		SortOrder
margin		Int
theme		String

UserSuccess

Field	Argument	Type	Description
user		User!

UsersError

Field	Argument	Type	Description
errorCodes		[UsersErrorCode!]!

UsersSuccess

Field	Argument	Type	Description
users		[User!]!

Webhook

Field	Argument	Type	Description
contentType		String!
createdAt		Date!
enabled		Boolean!
eventTypes		[WebhookEvent!]!
id		ID!
method		String!
updatedAt		Date!
url		String!

WebhookError

Field	Argument	Type	Description
errorCodes		[WebhookErrorCode!]!

WebhookSuccess

Field	Argument	Type	Description
webhook		Webhook!

WebhooksError

Field	Argument	Type	Description
errorCodes		[WebhooksErrorCode!]!

WebhooksSuccess

Field	Argument	Type	Description
webhooks		[Webhook!]!

Inputs

ArchiveLinkInput

Field		Type	Description
archived		Boolean!
linkId		ID!

ArticleHighlightsInput

Field		Type	Description
includeFriends		Boolean

CreateArticleInput

Field		Type	Description
articleSavingRequestId		ID
preparedDocument		PreparedDocumentInput
skipParsing		Boolean
source		String
uploadFileId		ID
url		String!

CreateArticleSavingRequestInput

Field		Type	Description
url		String!

CreateHighlightInput

Field		Type	Description
annotation		String
articleId		ID!
id		ID!
patch		String!
prefix		String
quote		String!
sharedAt		Date
shortId		String!
suffix		String

CreateHighlightReplyInput

Field		Type	Description
highlightId		ID!
text		String!

CreateLabelInput

Field		Type	Description
color		String!
description		String
name		String!

CreateReactionInput

Field		Type	Description
code		ReactionType!
highlightId		ID
userArticleId		ID

CreateReminderInput

Field		Type	Description
archiveUntil		Boolean!
clientRequestId		ID
linkId		ID
remindAt		Date!
sendNotification		Boolean!

GenerateApiKeyInput

Field		Type	Description
expiresAt		Date!
name		String!
scopes		[String!]

GoogleLoginInput

Field		Type	Description
email		String!
secret		String!

GoogleSignupInput

Field		Type	Description
bio		String
email		String!
name		String!
pictureUrl		String!
secret		String!
sourceUserId		String!
username		String!

LoginInput

Field		Type	Description
email		String!
password		String!

MergeHighlightInput

Field		Type	Description
annotation		String
articleId		ID!
id		ID!
overlapHighlightIdList		[String!]!
patch		String!
prefix		String
quote		String!
shortId		ID!
suffix		String

PageInfoInput

Field		Type	Description
author		String
canonicalUrl		String
contentType		String
description		String
previewImage		String
publishedAt		Date
title		String

PreparedDocumentInput

Field		Type	Description
document		String!
pageInfo		PageInfoInput!

ReportItemInput

Field		Type	Description
itemUrl		String!
pageId		ID!
reportComment		String!
reportTypes		[ReportType!]!
sharedBy		ID

SaveArticleReadingProgressInput

Field		Type	Description
id		ID!
readingProgressAnchorIndex		Int!
readingProgressPercent		Float!

SaveFileInput

Field		Type	Description
clientRequestId		ID!
source		String!
uploadFileId		ID!
url		String!

SavePageInput

Field		Type	Description
clientRequestId		ID!
originalContent		String!
source		String!
title		String
url		String!

SaveUrlInput

Field		Type	Description
clientRequestId		ID!
source		String!
url		String!

SetBookmarkArticleInput

Field		Type	Description
articleID		ID!
bookmark		Boolean!

SetDeviceTokenInput

Field		Type	Description
id		ID
token		String

SetFollowInput

Field		Type	Description
follow		Boolean!
userId		ID!

SetLabelsForHighlightInput

Field		Type	Description
highlightId		ID!
labelIds		[ID!]!

SetLabelsInput

Field		Type	Description
labelIds		[ID!]!
pageId		ID!

SetShareArticleInput

Field		Type	Description
articleID		ID!
share		Boolean!
sharedComment		String
sharedWithHighlights		Boolean

SetShareHighlightInput

Field		Type	Description
id		ID!
share		Boolean!

SetUserPersonalizationInput

Field		Type	Description
fontFamily		String
fontSize		Int
libraryLayoutType		String
librarySortOrder		SortOrder
margin		Int
theme		String

SetWebhookInput

Field		Type	Description
contentType		String
enabled		Boolean
eventTypes		[WebhookEvent!]!
id		ID
method		String
url		String!

SignupInput

Field		Type	Description
bio		String
email		String!
name		String!
password		String!
pictureUrl		String
username		String!

SortParams

Field		Type	Description
by		SortBy!
order		SortOrder

UpdateHighlightInput

Field		Type	Description
annotation		String
highlightId		ID!
sharedAt		Date

UpdateHighlightReplyInput

Field		Type	Description
highlightReplyId		ID!
text		String!

UpdateLabelInput

Field		Type	Description
color		String!
description		String
labelId		ID!
name		String!

UpdateLinkShareInfoInput

Field		Type	Description
description		String!
linkId		ID!
title		String!

UpdatePageInput

Field		Type	Description
description		String
pageId		ID!
title		String

UpdateReminderInput

Field		Type	Description
archiveUntil		Boolean!
id		ID!
remindAt		Date!
sendNotification		Boolean!

UpdateSharedCommentInput

Field		Type	Description
articleID		ID!
sharedComment		String!

UpdateUserInput

Field		Type	Description
bio		String
name		String!

UpdateUserProfileInput

Field		Type	Description
bio		String
pictureUrl		String
userId		ID!
username		String

UploadFileRequestInput

Field		Type	Description
clientRequestId		String
contentType		String!
createPageEntry		Boolean
url		String!

Enums

AddPopularReadErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

ApiKeysErrorCode

Value	Description
BAD_REQUEST
UNAUTHORIZED

ArchiveLinkErrorCode

Value	Description
BAD_REQUEST
UNAUTHORIZED

ArticleErrorCode

Value	Description
BAD_DATA
NOT_FOUND
UNAUTHORIZED

ArticleSavingRequestErrorCode

Value	Description
NOT_FOUND
UNAUTHORIZED

ArticleSavingRequestStatus

Value	Description
FAILED
PROCESSING
SUCCEEDED

ArticlesErrorCode

Value	Description
UNAUTHORIZED

ContentReader

Value	Description
PDF
WEB

CreateArticleErrorCode

Value	Description
ELASTIC_ERROR
NOT_ALLOWED_TO_PARSE
PAYLOAD_TOO_LARGE
UNABLE_TO_FETCH
UNABLE_TO_PARSE
UNAUTHORIZED
UPLOAD_FILE_MISSING

CreateArticleSavingRequestErrorCode

Value	Description
BAD_DATA
UNAUTHORIZED

CreateHighlightErrorCode

Value	Description
ALREADY_EXISTS
BAD_DATA
FORBIDDEN
NOT_FOUND
UNAUTHORIZED

CreateHighlightReplyErrorCode

Value	Description
EMPTY_ANNOTATION
FORBIDDEN
NOT_FOUND
UNAUTHORIZED

CreateLabelErrorCode

Value	Description
BAD_REQUEST
LABEL_ALREADY_EXISTS
NOT_FOUND
UNAUTHORIZED

CreateNewsletterEmailErrorCode

Value	Description
BAD_REQUEST
UNAUTHORIZED

CreateReactionErrorCode

Value	Description
BAD_CODE
BAD_TARGET
FORBIDDEN
NOT_FOUND
UNAUTHORIZED

CreateReminderErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

DeleteHighlightErrorCode

Value	Description
FORBIDDEN
NOT_FOUND
UNAUTHORIZED

DeleteHighlightReplyErrorCode

Value	Description
FORBIDDEN
NOT_FOUND
UNAUTHORIZED

DeleteLabelErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

DeleteNewsletterEmailErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

DeleteReactionErrorCode

Value	Description
FORBIDDEN
NOT_FOUND
UNAUTHORIZED

DeleteReminderErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

DeleteWebhookErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

FeedArticlesErrorCode

Value	Description
UNAUTHORIZED

GenerateApiKeyErrorCode

Value	Description
ALREADY_EXISTS
BAD_REQUEST
UNAUTHORIZED

GetFollowersErrorCode

Value	Description
UNAUTHORIZED

GetFollowingErrorCode

Value	Description
UNAUTHORIZED

GetUserPersonalizationErrorCode

Value	Description
UNAUTHORIZED

LabelsErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

LogOutErrorCode

Value	Description
LOG_OUT_FAILED

LoginErrorCode

Value	Description
ACCESS_DENIED
AUTH_FAILED
INVALID_CREDENTIALS
USER_ALREADY_EXISTS
USER_NOT_FOUND
WRONG_SOURCE

MergeHighlightErrorCode

Value	Description
ALREADY_EXISTS
BAD_DATA
FORBIDDEN
NOT_FOUND
UNAUTHORIZED

NewsletterEmailsErrorCode

Value	Description
BAD_REQUEST
UNAUTHORIZED

PageType

Value	Description
ARTICLE
BOOK
FILE
HIGHLIGHTS
PROFILE
UNKNOWN
WEBSITE

ReactionType

Value	Description
CRYING
HEART
HUSHED
LIKE
POUT
SMILE

ReminderErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

ReportType

Value	Description
ABUSIVE
CONTENT_DISPLAY
CONTENT_VIOLATION
SPAM

RevokeApiKeyErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

SaveArticleReadingProgressErrorCode

Value	Description
BAD_DATA
NOT_FOUND
UNAUTHORIZED

SaveErrorCode

Value	Description
UNAUTHORIZED
UNKNOWN

SearchErrorCode

Value	Description
UNAUTHORIZED

SendInstallInstructionsErrorCode

Value	Description
BAD_REQUEST
FORBIDDEN
NOT_FOUND
UNAUTHORIZED

SetBookmarkArticleErrorCode

Value	Description
BOOKMARK_EXISTS
NOT_FOUND

SetDeviceTokenErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

SetFollowErrorCode

Value	Description
NOT_FOUND
UNAUTHORIZED

SetLabelsErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

SetShareArticleErrorCode

Value	Description
NOT_FOUND
UNAUTHORIZED

SetShareHighlightErrorCode

Value	Description
FORBIDDEN
NOT_FOUND
UNAUTHORIZED

SetUserPersonalizationErrorCode

Value	Description
UNAUTHORIZED

SetWebhookErrorCode

Value	Description
ALREADY_EXISTS
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

SharedArticleErrorCode

Value	Description
NOT_FOUND

SignupErrorCode

Value	Description
ACCESS_DENIED
EXPIRED_TOKEN
GOOGLE_AUTH_ERROR
INVALID_PASSWORD
INVALID_USERNAME
UNKNOWN
USER_EXISTS

SortBy

Value	Description
PUBLISHED_AT
SAVED_AT
SCORE
UPDATED_TIME

SortOrder

Value	Description
ASCENDING
DESCENDING

SubscribeErrorCode

Value	Description
ALREADY_SUBSCRIBED
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

SubscriptionStatus

Value	Description
ACTIVE
DELETED
UNSUBSCRIBED

SubscriptionsErrorCode

Value	Description
BAD_REQUEST
UNAUTHORIZED

UnsubscribeErrorCode

Value	Description
ALREADY_UNSUBSCRIBED
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
UNSUBSCRIBE_METHOD_NOT_FOUND

UpdateHighlightErrorCode

Value	Description
BAD_DATA
FORBIDDEN
NOT_FOUND
UNAUTHORIZED

UpdateHighlightReplyErrorCode

Value	Description
FORBIDDEN
NOT_FOUND
UNAUTHORIZED

UpdateLabelErrorCode

Value	Description
BAD_REQUEST
FORBIDDEN
NOT_FOUND
UNAUTHORIZED

UpdateLinkShareInfoErrorCode

Value	Description
BAD_REQUEST
UNAUTHORIZED

UpdatePageErrorCode

Value	Description
BAD_REQUEST
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
UPDATE_FAILED

UpdateReminderErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

UpdateSharedCommentErrorCode

Value	Description
NOT_FOUND
UNAUTHORIZED

UpdateUserErrorCode

Value	Description
BIO_TOO_LONG
EMPTY_NAME
UNAUTHORIZED
USER_NOT_FOUND

UpdateUserProfileErrorCode

Value	Description
BAD_DATA
BAD_USERNAME
FORBIDDEN
UNAUTHORIZED
USERNAME_EXISTS

UploadFileRequestErrorCode

Value	Description
BAD_INPUT
FAILED_CREATE
UNAUTHORIZED

UploadFileStatus

Value	Description
COMPLETED
INITIALIZED

UserErrorCode

Value	Description
BAD_REQUEST
UNAUTHORIZED
USER_NOT_FOUND

UsersErrorCode

Value	Description
UNAUTHORIZED

WebhookErrorCode

Value	Description
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED

WebhookEvent

Value	Description
HIGHLIGHT_CREATED
HIGHLIGHT_DELETED
HIGHLIGHT_UPDATED
LABEL_CREATED
LABEL_DELETED
LABEL_UPDATED
PAGE_CREATED
PAGE_DELETED
PAGE_UPDATED

WebhooksErrorCode

Value	Description
BAD_REQUEST
UNAUTHORIZED

Scalars

Boolean

The Boolean scalar type represents true or false.

Date

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Unions

AddPopularReadResult

Type	Description
AddPopularReadError
AddPopularReadSuccess

ApiKeysResult

Type	Description
ApiKeysError
ApiKeysSuccess

ArchiveLinkResult

Type	Description
ArchiveLinkError
ArchiveLinkSuccess

ArticleResult

Type	Description
ArticleError
ArticleSuccess

ArticleSavingRequestResult

Type	Description
ArticleSavingRequestError
ArticleSavingRequestSuccess

ArticlesResult

Type	Description
ArticlesError
ArticlesSuccess

CreateArticleResult

Type	Description
CreateArticleError
CreateArticleSuccess

CreateArticleSavingRequestResult

Type	Description
CreateArticleSavingRequestError
CreateArticleSavingRequestSuccess

CreateHighlightReplyResult

Type	Description
CreateHighlightReplyError
CreateHighlightReplySuccess

CreateHighlightResult

Type	Description
CreateHighlightError
CreateHighlightSuccess

CreateLabelResult

Type	Description
CreateLabelError
CreateLabelSuccess

CreateNewsletterEmailResult

Type	Description
CreateNewsletterEmailError
CreateNewsletterEmailSuccess

CreateReactionResult

Type	Description
CreateReactionError
CreateReactionSuccess

CreateReminderResult

Type	Description
CreateReminderError
CreateReminderSuccess

DeleteHighlightReplyResult

Type	Description
DeleteHighlightReplyError
DeleteHighlightReplySuccess

DeleteHighlightResult

Type	Description
DeleteHighlightError
DeleteHighlightSuccess

DeleteLabelResult

Type	Description
DeleteLabelError
DeleteLabelSuccess

DeleteNewsletterEmailResult

Type	Description
DeleteNewsletterEmailError
DeleteNewsletterEmailSuccess

DeleteReactionResult

Type	Description
DeleteReactionError
DeleteReactionSuccess

DeleteReminderResult

Type	Description
DeleteReminderError
DeleteReminderSuccess

DeleteWebhookResult

Type	Description
DeleteWebhookError
DeleteWebhookSuccess

FeedArticlesResult

Type	Description
FeedArticlesError
FeedArticlesSuccess

GenerateApiKeyResult

Type	Description
GenerateApiKeyError
GenerateApiKeySuccess

GetFollowersResult

Type	Description
GetFollowersError
GetFollowersSuccess

GetFollowingResult

Type	Description
GetFollowingError
GetFollowingSuccess

GetUserPersonalizationResult

Type	Description
GetUserPersonalizationError
GetUserPersonalizationSuccess

GoogleSignupResult

Type	Description
GoogleSignupError
GoogleSignupSuccess

LabelsResult

Type	Description
LabelsError
LabelsSuccess

LogOutResult

Type	Description
LogOutError
LogOutSuccess

LoginResult

Type	Description
LoginError
LoginSuccess

MergeHighlightResult

Type	Description
MergeHighlightError
MergeHighlightSuccess

NewsletterEmailsResult

Type	Description
NewsletterEmailsError
NewsletterEmailsSuccess

ReminderResult

Type	Description
ReminderError
ReminderSuccess

RevokeApiKeyResult

Type	Description
RevokeApiKeyError
RevokeApiKeySuccess

SaveArticleReadingProgressResult

Type	Description
SaveArticleReadingProgressError
SaveArticleReadingProgressSuccess

SaveResult

Type	Description
SaveError
SaveSuccess

SearchResult

Type	Description
SearchError
SearchSuccess

SendInstallInstructionsResult

Type	Description
SendInstallInstructionsError
SendInstallInstructionsSuccess

SetBookmarkArticleResult

Type	Description
SetBookmarkArticleError
SetBookmarkArticleSuccess

SetDeviceTokenResult

Type	Description
SetDeviceTokenError
SetDeviceTokenSuccess

SetFollowResult

Type	Description
SetFollowError
SetFollowSuccess

SetLabelsResult

Type	Description
SetLabelsError
SetLabelsSuccess

SetShareArticleResult

Type	Description
SetShareArticleError
SetShareArticleSuccess

SetShareHighlightResult

Type	Description
SetShareHighlightError
SetShareHighlightSuccess

SetUserPersonalizationResult

Type	Description
SetUserPersonalizationError
SetUserPersonalizationSuccess

SetWebhookResult

Type	Description
SetWebhookError
SetWebhookSuccess

SharedArticleResult

Type	Description
SharedArticleError
SharedArticleSuccess

SignupResult

Type	Description
SignupError
SignupSuccess

SubscribeResult

Type	Description
SubscribeError
SubscribeSuccess

SubscriptionsResult

Type	Description
SubscriptionsError
SubscriptionsSuccess

UnsubscribeResult

Type	Description
UnsubscribeError
UnsubscribeSuccess

UpdateHighlightReplyResult

Type	Description
UpdateHighlightReplyError
UpdateHighlightReplySuccess

UpdateHighlightResult

Type	Description
UpdateHighlightError
UpdateHighlightSuccess

UpdateLabelResult

Type	Description
UpdateLabelError
UpdateLabelSuccess

UpdateLinkShareInfoResult

Type	Description
UpdateLinkShareInfoError
UpdateLinkShareInfoSuccess

UpdatePageResult

Type	Description
UpdatePageError
UpdatePageSuccess

UpdateReminderResult

Type	Description
UpdateReminderError
UpdateReminderSuccess

UpdateSharedCommentResult

Type	Description
UpdateSharedCommentError
UpdateSharedCommentSuccess

UpdateUserProfileResult

Type	Description
UpdateUserProfileError
UpdateUserProfileSuccess

UpdateUserResult

Type	Description
UpdateUserError
UpdateUserSuccess

UploadFileRequestResult

Type	Description
UploadFileRequestError
UploadFileRequestSuccess

UserResult

Type	Description
UserError
UserSuccess

UsersResult

Type	Description
UsersError
UsersSuccess

WebhookResult

Type	Description
WebhookError
WebhookSuccess

WebhooksResult

Type	Description
WebhooksError
WebhooksSuccess

Done in 0.36s.