diff --git a/packages/api/api.md b/packages/api/api.md new file mode 100644 index 000000000..9b0c5fb9c --- /dev/null +++ b/packages/api/api.md @@ -0,0 +1,9750 @@ +yarn run v1.22.18 +$ /Users/jacksonh/src/omnivore/node_modules/.bin/graphql-markdown src/generated/schema.graphql +# Schema Types + +
+ Table of Contents + + * [Query](#query) + * [Mutation](#mutation) + * [Objects](#objects) + * [AddPopularReadError](#addpopularreaderror) + * [AddPopularReadSuccess](#addpopularreadsuccess) + * [ApiKey](#apikey) + * [ApiKeysError](#apikeyserror) + * [ApiKeysSuccess](#apikeyssuccess) + * [ArchiveLinkError](#archivelinkerror) + * [ArchiveLinkSuccess](#archivelinksuccess) + * [Article](#article) + * [ArticleEdge](#articleedge) + * [ArticleError](#articleerror) + * [ArticleSavingRequest](#articlesavingrequest) + * [ArticleSavingRequestError](#articlesavingrequesterror) + * [ArticleSavingRequestSuccess](#articlesavingrequestsuccess) + * [ArticleSuccess](#articlesuccess) + * [ArticlesError](#articleserror) + * [ArticlesSuccess](#articlessuccess) + * [CreateArticleError](#createarticleerror) + * [CreateArticleSavingRequestError](#createarticlesavingrequesterror) + * [CreateArticleSavingRequestSuccess](#createarticlesavingrequestsuccess) + * [CreateArticleSuccess](#createarticlesuccess) + * [CreateHighlightError](#createhighlighterror) + * [CreateHighlightReplyError](#createhighlightreplyerror) + * [CreateHighlightReplySuccess](#createhighlightreplysuccess) + * [CreateHighlightSuccess](#createhighlightsuccess) + * [CreateLabelError](#createlabelerror) + * [CreateLabelSuccess](#createlabelsuccess) + * [CreateNewsletterEmailError](#createnewsletteremailerror) + * [CreateNewsletterEmailSuccess](#createnewsletteremailsuccess) + * [CreateReactionError](#createreactionerror) + * [CreateReactionSuccess](#createreactionsuccess) + * [CreateReminderError](#createremindererror) + * [CreateReminderSuccess](#createremindersuccess) + * [DeleteHighlightError](#deletehighlighterror) + * [DeleteHighlightReplyError](#deletehighlightreplyerror) + * [DeleteHighlightReplySuccess](#deletehighlightreplysuccess) + * [DeleteHighlightSuccess](#deletehighlightsuccess) + * [DeleteLabelError](#deletelabelerror) + * [DeleteLabelSuccess](#deletelabelsuccess) + * [DeleteNewsletterEmailError](#deletenewsletteremailerror) + * [DeleteNewsletterEmailSuccess](#deletenewsletteremailsuccess) + * [DeleteReactionError](#deletereactionerror) + * [DeleteReactionSuccess](#deletereactionsuccess) + * [DeleteReminderError](#deleteremindererror) + * [DeleteReminderSuccess](#deleteremindersuccess) + * [DeleteWebhookError](#deletewebhookerror) + * [DeleteWebhookSuccess](#deletewebhooksuccess) + * [DeviceToken](#devicetoken) + * [FeedArticle](#feedarticle) + * [FeedArticleEdge](#feedarticleedge) + * [FeedArticlesError](#feedarticleserror) + * [FeedArticlesSuccess](#feedarticlessuccess) + * [GenerateApiKeyError](#generateapikeyerror) + * [GenerateApiKeySuccess](#generateapikeysuccess) + * [GetFollowersError](#getfollowerserror) + * [GetFollowersSuccess](#getfollowerssuccess) + * [GetFollowingError](#getfollowingerror) + * [GetFollowingSuccess](#getfollowingsuccess) + * [GetUserPersonalizationError](#getuserpersonalizationerror) + * [GetUserPersonalizationSuccess](#getuserpersonalizationsuccess) + * [GoogleSignupError](#googlesignuperror) + * [GoogleSignupSuccess](#googlesignupsuccess) + * [Highlight](#highlight) + * [HighlightReply](#highlightreply) + * [HighlightStats](#highlightstats) + * [Label](#label) + * [LabelsError](#labelserror) + * [LabelsSuccess](#labelssuccess) + * [Link](#link) + * [LinkShareInfo](#linkshareinfo) + * [LogOutError](#logouterror) + * [LogOutSuccess](#logoutsuccess) + * [LoginError](#loginerror) + * [LoginSuccess](#loginsuccess) + * [MergeHighlightError](#mergehighlighterror) + * [MergeHighlightSuccess](#mergehighlightsuccess) + * [NewsletterEmail](#newsletteremail) + * [NewsletterEmailsError](#newsletteremailserror) + * [NewsletterEmailsSuccess](#newsletteremailssuccess) + * [Page](#page) + * [PageInfo](#pageinfo) + * [Profile](#profile) + * [Reaction](#reaction) + * [ReadState](#readstate) + * [Reminder](#reminder) + * [ReminderError](#remindererror) + * [ReminderSuccess](#remindersuccess) + * [ReportItemResult](#reportitemresult) + * [RevokeApiKeyError](#revokeapikeyerror) + * [RevokeApiKeySuccess](#revokeapikeysuccess) + * [SaveArticleReadingProgressError](#savearticlereadingprogresserror) + * [SaveArticleReadingProgressSuccess](#savearticlereadingprogresssuccess) + * [SaveError](#saveerror) + * [SaveSuccess](#savesuccess) + * [SearchError](#searcherror) + * [SearchItem](#searchitem) + * [SearchItemEdge](#searchitemedge) + * [SearchSuccess](#searchsuccess) + * [SendInstallInstructionsError](#sendinstallinstructionserror) + * [SendInstallInstructionsSuccess](#sendinstallinstructionssuccess) + * [SetBookmarkArticleError](#setbookmarkarticleerror) + * [SetBookmarkArticleSuccess](#setbookmarkarticlesuccess) + * [SetDeviceTokenError](#setdevicetokenerror) + * [SetDeviceTokenSuccess](#setdevicetokensuccess) + * [SetFollowError](#setfollowerror) + * [SetFollowSuccess](#setfollowsuccess) + * [SetLabelsError](#setlabelserror) + * [SetLabelsSuccess](#setlabelssuccess) + * [SetShareArticleError](#setsharearticleerror) + * [SetShareArticleSuccess](#setsharearticlesuccess) + * [SetShareHighlightError](#setsharehighlighterror) + * [SetShareHighlightSuccess](#setsharehighlightsuccess) + * [SetUserPersonalizationError](#setuserpersonalizationerror) + * [SetUserPersonalizationSuccess](#setuserpersonalizationsuccess) + * [SetWebhookError](#setwebhookerror) + * [SetWebhookSuccess](#setwebhooksuccess) + * [ShareStats](#sharestats) + * [SharedArticleError](#sharedarticleerror) + * [SharedArticleSuccess](#sharedarticlesuccess) + * [SignupError](#signuperror) + * [SignupSuccess](#signupsuccess) + * [SubscribeError](#subscribeerror) + * [SubscribeSuccess](#subscribesuccess) + * [Subscription](#subscription) + * [SubscriptionsError](#subscriptionserror) + * [SubscriptionsSuccess](#subscriptionssuccess) + * [UnsubscribeError](#unsubscribeerror) + * [UnsubscribeSuccess](#unsubscribesuccess) + * [UpdateHighlightError](#updatehighlighterror) + * [UpdateHighlightReplyError](#updatehighlightreplyerror) + * [UpdateHighlightReplySuccess](#updatehighlightreplysuccess) + * [UpdateHighlightSuccess](#updatehighlightsuccess) + * [UpdateLabelError](#updatelabelerror) + * [UpdateLabelSuccess](#updatelabelsuccess) + * [UpdateLinkShareInfoError](#updatelinkshareinfoerror) + * [UpdateLinkShareInfoSuccess](#updatelinkshareinfosuccess) + * [UpdatePageError](#updatepageerror) + * [UpdatePageSuccess](#updatepagesuccess) + * [UpdateReminderError](#updateremindererror) + * [UpdateReminderSuccess](#updateremindersuccess) + * [UpdateSharedCommentError](#updatesharedcommenterror) + * [UpdateSharedCommentSuccess](#updatesharedcommentsuccess) + * [UpdateUserError](#updateusererror) + * [UpdateUserProfileError](#updateuserprofileerror) + * [UpdateUserProfileSuccess](#updateuserprofilesuccess) + * [UpdateUserSuccess](#updateusersuccess) + * [UploadFileRequestError](#uploadfilerequesterror) + * [UploadFileRequestSuccess](#uploadfilerequestsuccess) + * [User](#user) + * [UserError](#usererror) + * [UserPersonalization](#userpersonalization) + * [UserSuccess](#usersuccess) + * [UsersError](#userserror) + * [UsersSuccess](#userssuccess) + * [Webhook](#webhook) + * [WebhookError](#webhookerror) + * [WebhookSuccess](#webhooksuccess) + * [WebhooksError](#webhookserror) + * [WebhooksSuccess](#webhookssuccess) + * [Inputs](#inputs) + * [ArchiveLinkInput](#archivelinkinput) + * [ArticleHighlightsInput](#articlehighlightsinput) + * [CreateArticleInput](#createarticleinput) + * [CreateArticleSavingRequestInput](#createarticlesavingrequestinput) + * [CreateHighlightInput](#createhighlightinput) + * [CreateHighlightReplyInput](#createhighlightreplyinput) + * [CreateLabelInput](#createlabelinput) + * [CreateReactionInput](#createreactioninput) + * [CreateReminderInput](#createreminderinput) + * [GenerateApiKeyInput](#generateapikeyinput) + * [GoogleLoginInput](#googlelogininput) + * [GoogleSignupInput](#googlesignupinput) + * [LoginInput](#logininput) + * [MergeHighlightInput](#mergehighlightinput) + * [PageInfoInput](#pageinfoinput) + * [PreparedDocumentInput](#prepareddocumentinput) + * [ReportItemInput](#reportiteminput) + * [SaveArticleReadingProgressInput](#savearticlereadingprogressinput) + * [SaveFileInput](#savefileinput) + * [SavePageInput](#savepageinput) + * [SaveUrlInput](#saveurlinput) + * [SetBookmarkArticleInput](#setbookmarkarticleinput) + * [SetDeviceTokenInput](#setdevicetokeninput) + * [SetFollowInput](#setfollowinput) + * [SetLabelsForHighlightInput](#setlabelsforhighlightinput) + * [SetLabelsInput](#setlabelsinput) + * [SetShareArticleInput](#setsharearticleinput) + * [SetShareHighlightInput](#setsharehighlightinput) + * [SetUserPersonalizationInput](#setuserpersonalizationinput) + * [SetWebhookInput](#setwebhookinput) + * [SignupInput](#signupinput) + * [SortParams](#sortparams) + * [UpdateHighlightInput](#updatehighlightinput) + * [UpdateHighlightReplyInput](#updatehighlightreplyinput) + * [UpdateLabelInput](#updatelabelinput) + * [UpdateLinkShareInfoInput](#updatelinkshareinfoinput) + * [UpdatePageInput](#updatepageinput) + * [UpdateReminderInput](#updatereminderinput) + * [UpdateSharedCommentInput](#updatesharedcommentinput) + * [UpdateUserInput](#updateuserinput) + * [UpdateUserProfileInput](#updateuserprofileinput) + * [UploadFileRequestInput](#uploadfilerequestinput) + * [Enums](#enums) + * [AddPopularReadErrorCode](#addpopularreaderrorcode) + * [ApiKeysErrorCode](#apikeyserrorcode) + * [ArchiveLinkErrorCode](#archivelinkerrorcode) + * [ArticleErrorCode](#articleerrorcode) + * [ArticleSavingRequestErrorCode](#articlesavingrequesterrorcode) + * [ArticleSavingRequestStatus](#articlesavingrequeststatus) + * [ArticlesErrorCode](#articleserrorcode) + * [ContentReader](#contentreader) + * [CreateArticleErrorCode](#createarticleerrorcode) + * [CreateArticleSavingRequestErrorCode](#createarticlesavingrequesterrorcode) + * [CreateHighlightErrorCode](#createhighlighterrorcode) + * [CreateHighlightReplyErrorCode](#createhighlightreplyerrorcode) + * [CreateLabelErrorCode](#createlabelerrorcode) + * [CreateNewsletterEmailErrorCode](#createnewsletteremailerrorcode) + * [CreateReactionErrorCode](#createreactionerrorcode) + * [CreateReminderErrorCode](#createremindererrorcode) + * [DeleteHighlightErrorCode](#deletehighlighterrorcode) + * [DeleteHighlightReplyErrorCode](#deletehighlightreplyerrorcode) + * [DeleteLabelErrorCode](#deletelabelerrorcode) + * [DeleteNewsletterEmailErrorCode](#deletenewsletteremailerrorcode) + * [DeleteReactionErrorCode](#deletereactionerrorcode) + * [DeleteReminderErrorCode](#deleteremindererrorcode) + * [DeleteWebhookErrorCode](#deletewebhookerrorcode) + * [FeedArticlesErrorCode](#feedarticleserrorcode) + * [GenerateApiKeyErrorCode](#generateapikeyerrorcode) + * [GetFollowersErrorCode](#getfollowerserrorcode) + * [GetFollowingErrorCode](#getfollowingerrorcode) + * [GetUserPersonalizationErrorCode](#getuserpersonalizationerrorcode) + * [LabelsErrorCode](#labelserrorcode) + * [LogOutErrorCode](#logouterrorcode) + * [LoginErrorCode](#loginerrorcode) + * [MergeHighlightErrorCode](#mergehighlighterrorcode) + * [NewsletterEmailsErrorCode](#newsletteremailserrorcode) + * [PageType](#pagetype) + * [ReactionType](#reactiontype) + * [ReminderErrorCode](#remindererrorcode) + * [ReportType](#reporttype) + * [RevokeApiKeyErrorCode](#revokeapikeyerrorcode) + * [SaveArticleReadingProgressErrorCode](#savearticlereadingprogresserrorcode) + * [SaveErrorCode](#saveerrorcode) + * [SearchErrorCode](#searcherrorcode) + * [SendInstallInstructionsErrorCode](#sendinstallinstructionserrorcode) + * [SetBookmarkArticleErrorCode](#setbookmarkarticleerrorcode) + * [SetDeviceTokenErrorCode](#setdevicetokenerrorcode) + * [SetFollowErrorCode](#setfollowerrorcode) + * [SetLabelsErrorCode](#setlabelserrorcode) + * [SetShareArticleErrorCode](#setsharearticleerrorcode) + * [SetShareHighlightErrorCode](#setsharehighlighterrorcode) + * [SetUserPersonalizationErrorCode](#setuserpersonalizationerrorcode) + * [SetWebhookErrorCode](#setwebhookerrorcode) + * [SharedArticleErrorCode](#sharedarticleerrorcode) + * [SignupErrorCode](#signuperrorcode) + * [SortBy](#sortby) + * [SortOrder](#sortorder) + * [SubscribeErrorCode](#subscribeerrorcode) + * [SubscriptionStatus](#subscriptionstatus) + * [SubscriptionsErrorCode](#subscriptionserrorcode) + * [UnsubscribeErrorCode](#unsubscribeerrorcode) + * [UpdateHighlightErrorCode](#updatehighlighterrorcode) + * [UpdateHighlightReplyErrorCode](#updatehighlightreplyerrorcode) + * [UpdateLabelErrorCode](#updatelabelerrorcode) + * [UpdateLinkShareInfoErrorCode](#updatelinkshareinfoerrorcode) + * [UpdatePageErrorCode](#updatepageerrorcode) + * [UpdateReminderErrorCode](#updateremindererrorcode) + * [UpdateSharedCommentErrorCode](#updatesharedcommenterrorcode) + * [UpdateUserErrorCode](#updateusererrorcode) + * [UpdateUserProfileErrorCode](#updateuserprofileerrorcode) + * [UploadFileRequestErrorCode](#uploadfilerequesterrorcode) + * [UploadFileStatus](#uploadfilestatus) + * [UserErrorCode](#usererrorcode) + * [UsersErrorCode](#userserrorcode) + * [WebhookErrorCode](#webhookerrorcode) + * [WebhookEvent](#webhookevent) + * [WebhooksErrorCode](#webhookserrorcode) + * [Scalars](#scalars) + * [Boolean](#boolean) + * [Date](#date) + * [Float](#float) + * [ID](#id) + * [Int](#int) + * [String](#string) + * [Unions](#unions) + * [AddPopularReadResult](#addpopularreadresult) + * [ApiKeysResult](#apikeysresult) + * [ArchiveLinkResult](#archivelinkresult) + * [ArticleResult](#articleresult) + * [ArticleSavingRequestResult](#articlesavingrequestresult) + * [ArticlesResult](#articlesresult) + * [CreateArticleResult](#createarticleresult) + * [CreateArticleSavingRequestResult](#createarticlesavingrequestresult) + * [CreateHighlightReplyResult](#createhighlightreplyresult) + * [CreateHighlightResult](#createhighlightresult) + * [CreateLabelResult](#createlabelresult) + * [CreateNewsletterEmailResult](#createnewsletteremailresult) + * [CreateReactionResult](#createreactionresult) + * [CreateReminderResult](#createreminderresult) + * [DeleteHighlightReplyResult](#deletehighlightreplyresult) + * [DeleteHighlightResult](#deletehighlightresult) + * [DeleteLabelResult](#deletelabelresult) + * [DeleteNewsletterEmailResult](#deletenewsletteremailresult) + * [DeleteReactionResult](#deletereactionresult) + * [DeleteReminderResult](#deletereminderresult) + * [DeleteWebhookResult](#deletewebhookresult) + * [FeedArticlesResult](#feedarticlesresult) + * [GenerateApiKeyResult](#generateapikeyresult) + * [GetFollowersResult](#getfollowersresult) + * [GetFollowingResult](#getfollowingresult) + * [GetUserPersonalizationResult](#getuserpersonalizationresult) + * [GoogleSignupResult](#googlesignupresult) + * [LabelsResult](#labelsresult) + * [LogOutResult](#logoutresult) + * [LoginResult](#loginresult) + * [MergeHighlightResult](#mergehighlightresult) + * [NewsletterEmailsResult](#newsletteremailsresult) + * [ReminderResult](#reminderresult) + * [RevokeApiKeyResult](#revokeapikeyresult) + * [SaveArticleReadingProgressResult](#savearticlereadingprogressresult) + * [SaveResult](#saveresult) + * [SearchResult](#searchresult) + * [SendInstallInstructionsResult](#sendinstallinstructionsresult) + * [SetBookmarkArticleResult](#setbookmarkarticleresult) + * [SetDeviceTokenResult](#setdevicetokenresult) + * [SetFollowResult](#setfollowresult) + * [SetLabelsResult](#setlabelsresult) + * [SetShareArticleResult](#setsharearticleresult) + * [SetShareHighlightResult](#setsharehighlightresult) + * [SetUserPersonalizationResult](#setuserpersonalizationresult) + * [SetWebhookResult](#setwebhookresult) + * [SharedArticleResult](#sharedarticleresult) + * [SignupResult](#signupresult) + * [SubscribeResult](#subscriberesult) + * [SubscriptionsResult](#subscriptionsresult) + * [UnsubscribeResult](#unsubscriberesult) + * [UpdateHighlightReplyResult](#updatehighlightreplyresult) + * [UpdateHighlightResult](#updatehighlightresult) + * [UpdateLabelResult](#updatelabelresult) + * [UpdateLinkShareInfoResult](#updatelinkshareinforesult) + * [UpdatePageResult](#updatepageresult) + * [UpdateReminderResult](#updatereminderresult) + * [UpdateSharedCommentResult](#updatesharedcommentresult) + * [UpdateUserProfileResult](#updateuserprofileresult) + * [UpdateUserResult](#updateuserresult) + * [UploadFileRequestResult](#uploadfilerequestresult) + * [UserResult](#userresult) + * [UsersResult](#usersresult) + * [WebhookResult](#webhookresult) + * [WebhooksResult](#webhooksresult) + +
+ +## Query + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
apiKeysApiKeysResult!
articleArticleResult!
slugString!
usernameString!
articleSavingRequestArticleSavingRequestResult!
idID!
articlesArticlesResult!
afterString
firstInt
includePendingBoolean
queryString
sharedOnlyBoolean
sortSortParams
feedArticlesFeedArticlesResult!
afterString
firstInt
sharedByUserID
sortSortParams
getFollowersGetFollowersResult!
userIdID
getFollowingGetFollowingResult!
userIdID
getUserPersonalizationGetUserPersonalizationResult!
helloString
labelsLabelsResult!
meUser
newsletterEmailsNewsletterEmailsResult!
reminderReminderResult!
linkIdID!
searchSearchResult!
afterString
firstInt
queryString
sendInstallInstructionsSendInstallInstructionsResult!
sharedArticleSharedArticleResult!
selectedHighlightIdString
slugString!
usernameString!
subscriptionsSubscriptionsResult!
sortSortParams
userUserResult!
userIdID
usernameString
usersUsersResult!
validateUsernameBoolean!
usernameString!
webhookWebhookResult!
idID!
webhooksWebhooksResult!
+ +## Mutation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
addPopularReadAddPopularReadResult!
nameString!
createArticleCreateArticleResult!
inputCreateArticleInput!
createArticleSavingRequestCreateArticleSavingRequestResult!
inputCreateArticleSavingRequestInput!
createHighlightCreateHighlightResult!
inputCreateHighlightInput!
createHighlightReplyCreateHighlightReplyResult!
inputCreateHighlightReplyInput!
createLabelCreateLabelResult!
inputCreateLabelInput!
createNewsletterEmailCreateNewsletterEmailResult!
createReactionCreateReactionResult!
inputCreateReactionInput!
createReminderCreateReminderResult!
inputCreateReminderInput!
deleteHighlightDeleteHighlightResult!
highlightIdID!
deleteHighlightReplyDeleteHighlightReplyResult!
highlightReplyIdID!
deleteLabelDeleteLabelResult!
idID!
deleteNewsletterEmailDeleteNewsletterEmailResult!
newsletterEmailIdID!
deleteReactionDeleteReactionResult!
idID!
deleteReminderDeleteReminderResult!
idID!
deleteWebhookDeleteWebhookResult!
idID!
generateApiKeyGenerateApiKeyResult!
inputGenerateApiKeyInput!
googleLoginLoginResult!
inputGoogleLoginInput!
googleSignupGoogleSignupResult!
inputGoogleSignupInput!
logOutLogOutResult!
loginLoginResult!
inputLoginInput!
mergeHighlightMergeHighlightResult!
inputMergeHighlightInput!
reportItemReportItemResult!
inputReportItemInput!
revokeApiKeyRevokeApiKeyResult!
idID!
saveArticleReadingProgressSaveArticleReadingProgressResult!
inputSaveArticleReadingProgressInput!
saveFileSaveResult!
inputSaveFileInput!
savePageSaveResult!
inputSavePageInput!
saveUrlSaveResult!
inputSaveUrlInput!
setBookmarkArticleSetBookmarkArticleResult!
inputSetBookmarkArticleInput!
setDeviceTokenSetDeviceTokenResult!
inputSetDeviceTokenInput!
setFollowSetFollowResult!
inputSetFollowInput!
setLabelsSetLabelsResult!
inputSetLabelsInput!
setLabelsForHighlightSetLabelsResult!
inputSetLabelsForHighlightInput!
setLinkArchivedArchiveLinkResult!
inputArchiveLinkInput!
setShareArticleSetShareArticleResult!
inputSetShareArticleInput!
setShareHighlightSetShareHighlightResult!
inputSetShareHighlightInput!
setUserPersonalizationSetUserPersonalizationResult!
inputSetUserPersonalizationInput!
setWebhookSetWebhookResult!
inputSetWebhookInput!
signupSignupResult!
inputSignupInput!
subscribeSubscribeResult!
nameString!
unsubscribeUnsubscribeResult!
nameString!
updateHighlightUpdateHighlightResult!
inputUpdateHighlightInput!
updateHighlightReplyUpdateHighlightReplyResult!
inputUpdateHighlightReplyInput!
updateLabelUpdateLabelResult!
inputUpdateLabelInput!
updateLinkShareInfoUpdateLinkShareInfoResult!
inputUpdateLinkShareInfoInput!
updatePageUpdatePageResult!
inputUpdatePageInput!
updateReminderUpdateReminderResult!
inputUpdateReminderInput!
updateSharedCommentUpdateSharedCommentResult!
inputUpdateSharedCommentInput!
updateUserUpdateUserResult!
inputUpdateUserInput!
updateUserProfileUpdateUserProfileResult!
inputUpdateUserProfileInput!
uploadFileRequestUploadFileRequestResult!
inputUploadFileRequestInput!
+ +## Objects + +### AddPopularReadError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[AddPopularReadErrorCode!]!
+ +### AddPopularReadSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
pageIdString!
+ +### ApiKey + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
createdAtDate!
expiresAtDate!
idID!
keyString
nameString!
scopes[String!]
usedAtDate
+ +### ApiKeysError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[ApiKeysErrorCode!]!
+ +### ApiKeysSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
apiKeys[ApiKey!]!
+ +### ArchiveLinkError + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[ArchiveLinkErrorCode!]!
messageString!
+ +### ArchiveLinkSuccess + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
linkIdString!
messageString!
+ +### Article + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
authorString
contentString!
contentReaderContentReader!
createdAtDate!
descriptionString
hasContentBoolean
hashString!
highlights[Highlight!]!
inputArticleHighlightsInput
idID!
imageString
isArchivedBoolean!
labels[Label!]
languageString
linkIdID
originalArticleUrlString
originalHtmlString
pageTypePageType
postedByViewerBoolean
publishedAtDate
readAtDate
readingProgressAnchorIndexInt!
readingProgressPercentFloat!
savedAtDate!
savedByViewerBoolean
shareInfoLinkShareInfo
sharedCommentString
siteIconString
siteNameString
slugString!
stateArticleSavingRequestStatus
subscriptionString
titleString!
unsubHttpUrlString
unsubMailToString
updatedAtDate!
uploadFileIdID
urlString!
+ +### ArticleEdge + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
cursorString!
nodeArticle!
+ +### ArticleError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[ArticleErrorCode!]!
+ +### ArticleSavingRequest + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
article ⚠️Article +

⚠️ DEPRECATED

+
+ +article has been replaced with slug + +
+
createdAtDate!
errorCodeCreateArticleErrorCode
idID!
slugString!
statusArticleSavingRequestStatus!
updatedAtDate!
userUser!
userId ⚠️ID! +

⚠️ DEPRECATED

+
+ +userId has been replaced with user + +
+
+ +### ArticleSavingRequestError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[ArticleSavingRequestErrorCode!]!
+ +### ArticleSavingRequestSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
articleSavingRequestArticleSavingRequest!
+ +### ArticleSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
articleArticle!
+ +### ArticlesError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[ArticlesErrorCode!]!
+ +### ArticlesSuccess + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
edges[ArticleEdge!]!
pageInfoPageInfo!
+ +### CreateArticleError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[CreateArticleErrorCode!]!
+ +### CreateArticleSavingRequestError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[CreateArticleSavingRequestErrorCode!]!
+ +### CreateArticleSavingRequestSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
articleSavingRequestArticleSavingRequest!
+ +### CreateArticleSuccess + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
createdBoolean!
createdArticleArticle!
userUser!
+ +### CreateHighlightError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[CreateHighlightErrorCode!]!
+ +### CreateHighlightReplyError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[CreateHighlightReplyErrorCode!]!
+ +### CreateHighlightReplySuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
highlightReplyHighlightReply!
+ +### CreateHighlightSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
highlightHighlight!
+ +### CreateLabelError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[CreateLabelErrorCode!]!
+ +### CreateLabelSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
labelLabel!
+ +### CreateNewsletterEmailError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[CreateNewsletterEmailErrorCode!]!
+ +### CreateNewsletterEmailSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
newsletterEmailNewsletterEmail!
+ +### CreateReactionError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[CreateReactionErrorCode!]!
+ +### CreateReactionSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
reactionReaction!
+ +### CreateReminderError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[CreateReminderErrorCode!]!
+ +### CreateReminderSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
reminderReminder!
+ +### DeleteHighlightError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[DeleteHighlightErrorCode!]!
+ +### DeleteHighlightReplyError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[DeleteHighlightReplyErrorCode!]!
+ +### DeleteHighlightReplySuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
highlightReplyHighlightReply!
+ +### DeleteHighlightSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
highlightHighlight!
+ +### DeleteLabelError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[DeleteLabelErrorCode!]!
+ +### DeleteLabelSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
labelLabel!
+ +### DeleteNewsletterEmailError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[DeleteNewsletterEmailErrorCode!]!
+ +### DeleteNewsletterEmailSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
newsletterEmailNewsletterEmail!
+ +### DeleteReactionError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[DeleteReactionErrorCode!]!
+ +### DeleteReactionSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
reactionReaction!
+ +### DeleteReminderError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[DeleteReminderErrorCode!]!
+ +### DeleteReminderSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
reminderReminder!
+ +### DeleteWebhookError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[DeleteWebhookErrorCode!]!
+ +### DeleteWebhookSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
webhookWebhook!
+ +### DeviceToken + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
createdAtDate!
idID!
tokenString!
+ +### FeedArticle + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
annotationsCountInt
articleArticle!
highlightHighlight
highlightsCountInt
idID!
reactions[Reaction!]!
sharedAtDate!
sharedByUser!
sharedCommentString
sharedWithHighlightsBoolean
+ +### FeedArticleEdge + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
cursorString!
nodeFeedArticle!
+ +### FeedArticlesError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[FeedArticlesErrorCode!]!
+ +### FeedArticlesSuccess + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
edges[FeedArticleEdge!]!
pageInfoPageInfo!
+ +### GenerateApiKeyError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[GenerateApiKeyErrorCode!]!
+ +### GenerateApiKeySuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
apiKeyApiKey!
+ +### GetFollowersError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[GetFollowersErrorCode!]!
+ +### GetFollowersSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
followers[User!]!
+ +### GetFollowingError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[GetFollowingErrorCode!]!
+ +### GetFollowingSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
following[User!]!
+ +### GetUserPersonalizationError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[GetUserPersonalizationErrorCode!]!
+ +### GetUserPersonalizationSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
userPersonalizationUserPersonalization
+ +### GoogleSignupError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SignupErrorCode]!
+ +### GoogleSignupSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
meUser!
+ +### Highlight + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
annotationString
createdAtDate!
createdByMeBoolean!
idID!
patchString!
prefixString
quoteString!
reactions[Reaction!]!
replies[HighlightReply!]!
sharedAtDate
shortIdString!
suffixString
updatedAtDate!
userUser!
+ +### HighlightReply + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
createdAtDate!
highlightHighlight!
idID!
textString!
updatedAtDate!
userUser!
+ +### HighlightStats + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
highlightCountInt!
+ +### Label + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
colorString!
createdAtDate
descriptionString
idID!
nameString!
+ +### LabelsError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[LabelsErrorCode!]!
+ +### LabelsSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
labels[Label!]!
+ +### Link + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
highlightStatsHighlightStats!
idID!
pagePage!
postedByViewerBoolean!
readStateReadState!
savedAtDate!
savedByUser!
savedByViewerBoolean!
shareInfoLinkShareInfo!
shareStatsShareStats!
slugString!
updatedAtDate!
urlString!
+ +### LinkShareInfo + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
descriptionString!
imageUrlString!
titleString!
+ +### LogOutError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[LogOutErrorCode!]!
+ +### LogOutSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
messageString
+ +### LoginError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[LoginErrorCode!]!
+ +### LoginSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
meUser!
+ +### MergeHighlightError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[MergeHighlightErrorCode!]!
+ +### MergeHighlightSuccess + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
highlightHighlight!
overlapHighlightIdList[String!]!
+ +### NewsletterEmail + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
addressString!
confirmationCodeString
idID!
+ +### NewsletterEmailsError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[NewsletterEmailsErrorCode!]!
+ +### NewsletterEmailsSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
newsletterEmails[NewsletterEmail!]!
+ +### Page + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
authorString
createdAtDate!
descriptionString
hashString!
idID!
imageString!
originalHtmlString!
originalUrlString!
publishedAtDate
readableHtmlString!
titleString!
typePageType!
updatedAtDate!
urlString!
+ +### PageInfo + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
endCursorString
hasNextPageBoolean!
hasPreviousPageBoolean!
startCursorString
totalCountInt
+ +### Profile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
bioString
idID!
pictureUrlString
privateBoolean!
usernameString!
+ +### Reaction + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
codeReactionType!
createdAtDate!
idID!
updatedAtDate
userUser!
+ +### ReadState + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
progressAnchorIndexInt!
progressPercentFloat!
readingBoolean
readingTimeInt
+ +### Reminder + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
archiveUntilBoolean!
idID!
remindAtDate!
sendNotificationBoolean!
+ +### ReminderError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[ReminderErrorCode!]!
+ +### ReminderSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
reminderReminder!
+ +### ReportItemResult + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
messageString!
+ +### RevokeApiKeyError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[RevokeApiKeyErrorCode!]!
+ +### RevokeApiKeySuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
apiKeyApiKey!
+ +### SaveArticleReadingProgressError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SaveArticleReadingProgressErrorCode!]!
+ +### SaveArticleReadingProgressSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
updatedArticleArticle!
+ +### SaveError + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SaveErrorCode!]!
messageString
+ +### SaveSuccess + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
clientRequestIdID!
urlString!
+ +### SearchError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SearchErrorCode!]!
+ +### SearchItem + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
annotationString
authorString
contentReaderContentReader!
createdAtDate!
descriptionString
highlights[Highlight!]
idID!
imageString
isArchivedBoolean!
labels[Label!]
languageString
originalArticleUrlString
ownedByViewerBoolean
pageIdID
pageTypePageType!
publishedAtDate
quoteString
readAtDate
readingProgressAnchorIndexInt!
readingProgressPercentFloat!
savedAtDate!
shortIdString
siteNameString
slugString!
stateArticleSavingRequestStatus
subscriptionString
titleString!
unsubHttpUrlString
unsubMailToString
updatedAtDate
uploadFileIdID
urlString!
+ +### SearchItemEdge + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
cursorString!
nodeSearchItem!
+ +### SearchSuccess + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
edges[SearchItemEdge!]!
pageInfoPageInfo!
+ +### SendInstallInstructionsError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SendInstallInstructionsErrorCode!]!
+ +### SendInstallInstructionsSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
sentBoolean!
+ +### SetBookmarkArticleError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SetBookmarkArticleErrorCode!]!
+ +### SetBookmarkArticleSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
bookmarkedArticleArticle!
+ +### SetDeviceTokenError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SetDeviceTokenErrorCode!]!
+ +### SetDeviceTokenSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
deviceTokenDeviceToken!
+ +### SetFollowError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SetFollowErrorCode!]!
+ +### SetFollowSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
updatedUserUser!
+ +### SetLabelsError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SetLabelsErrorCode!]!
+ +### SetLabelsSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
labels[Label!]!
+ +### SetShareArticleError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SetShareArticleErrorCode!]!
+ +### SetShareArticleSuccess + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
updatedArticleArticle!
updatedFeedArticleFeedArticle
updatedFeedArticleIdString
+ +### SetShareHighlightError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SetShareHighlightErrorCode!]!
+ +### SetShareHighlightSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
highlightHighlight!
+ +### SetUserPersonalizationError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SetUserPersonalizationErrorCode!]!
+ +### SetUserPersonalizationSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
updatedUserPersonalizationUserPersonalization!
+ +### SetWebhookError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SetWebhookErrorCode!]!
+ +### SetWebhookSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
webhookWebhook!
+ +### ShareStats + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
readDurationInt!
saveCountInt!
viewCountInt!
+ +### SharedArticleError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SharedArticleErrorCode!]!
+ +### SharedArticleSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
articleArticle!
+ +### SignupError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SignupErrorCode]!
+ +### SignupSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
meUser!
+ +### SubscribeError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SubscribeErrorCode!]!
+ +### SubscribeSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
subscriptions[Subscription!]!
+ +### Subscription + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
createdAtDate!
descriptionString
idID!
nameString!
newsletterEmailString!
statusSubscriptionStatus!
unsubscribeHttpUrlString
unsubscribeMailToString
updatedAtDate!
urlString
+ +### SubscriptionsError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[SubscriptionsErrorCode!]!
+ +### SubscriptionsSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
subscriptions[Subscription!]!
+ +### UnsubscribeError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UnsubscribeErrorCode!]!
+ +### UnsubscribeSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
subscriptionSubscription!
+ +### UpdateHighlightError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UpdateHighlightErrorCode!]!
+ +### UpdateHighlightReplyError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UpdateHighlightReplyErrorCode!]!
+ +### UpdateHighlightReplySuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
highlightReplyHighlightReply!
+ +### UpdateHighlightSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
highlightHighlight!
+ +### UpdateLabelError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UpdateLabelErrorCode!]!
+ +### UpdateLabelSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
labelLabel!
+ +### UpdateLinkShareInfoError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UpdateLinkShareInfoErrorCode!]!
+ +### UpdateLinkShareInfoSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
messageString!
+ +### UpdatePageError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UpdatePageErrorCode!]!
+ +### UpdatePageSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
updatedPageArticle!
+ +### UpdateReminderError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UpdateReminderErrorCode!]!
+ +### UpdateReminderSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
reminderReminder!
+ +### UpdateSharedCommentError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UpdateSharedCommentErrorCode!]!
+ +### UpdateSharedCommentSuccess + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
articleIDID!
sharedCommentString!
+ +### UpdateUserError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UpdateUserErrorCode!]!
+ +### UpdateUserProfileError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UpdateUserProfileErrorCode!]!
+ +### UpdateUserProfileSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
userUser!
+ +### UpdateUserSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
userUser!
+ +### UploadFileRequestError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UploadFileRequestErrorCode!]!
+ +### UploadFileRequestSuccess + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
createdPageIdString
idID!
uploadFileIdID
uploadSignedUrlString
+ +### User + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
followersCountInt
friendsCountInt
idID!
isFriend ⚠️Boolean +

⚠️ DEPRECATED

+
+ +isFriend has been replaced with viewerIsFollowing + +
+
isFullUserBoolean
nameString!
pictureString
profileProfile!
sharedArticles[FeedArticle!]!
sharedArticlesCountInt
sharedHighlightsCountInt
sharedNotesCountInt
viewerIsFollowingBoolean
+ +### UserError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UserErrorCode!]!
+ +### UserPersonalization + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
fontFamilyString
fontSizeInt
idID
libraryLayoutTypeString
librarySortOrderSortOrder
marginInt
themeString
+ +### UserSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
userUser!
+ +### UsersError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[UsersErrorCode!]!
+ +### UsersSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
users[User!]!
+ +### Webhook + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
contentTypeString!
createdAtDate!
enabledBoolean!
eventTypes[WebhookEvent!]!
idID!
methodString!
updatedAtDate!
urlString!
+ +### WebhookError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[WebhookErrorCode!]!
+ +### WebhookSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
webhookWebhook!
+ +### WebhooksError + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
errorCodes[WebhooksErrorCode!]!
+ +### WebhooksSuccess + + + + + + + + + + + + + + + + + +
FieldArgumentTypeDescription
webhooks[Webhook!]!
+ +## Inputs + +### ArchiveLinkInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
archivedBoolean!
linkIdID!
+ +### ArticleHighlightsInput + + + + + + + + + + + + + + + + +
FieldTypeDescription
includeFriendsBoolean
+ +### CreateArticleInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
articleSavingRequestIdID
preparedDocumentPreparedDocumentInput
skipParsingBoolean
sourceString
uploadFileIdID
urlString!
+ +### CreateArticleSavingRequestInput + + + + + + + + + + + + + + + + +
FieldTypeDescription
urlString!
+ +### CreateHighlightInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
annotationString
articleIdID!
idID!
patchString!
prefixString
quoteString!
sharedAtDate
shortIdString!
suffixString
+ +### CreateHighlightReplyInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
highlightIdID!
textString!
+ +### CreateLabelInput + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
colorString!
descriptionString
nameString!
+ +### CreateReactionInput + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
codeReactionType!
highlightIdID
userArticleIdID
+ +### CreateReminderInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
archiveUntilBoolean!
clientRequestIdID
linkIdID
remindAtDate!
sendNotificationBoolean!
+ +### GenerateApiKeyInput + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
expiresAtDate!
nameString!
scopes[String!]
+ +### GoogleLoginInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
emailString!
secretString!
+ +### GoogleSignupInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
bioString
emailString!
nameString!
pictureUrlString!
secretString!
sourceUserIdString!
usernameString!
+ +### LoginInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
emailString!
passwordString!
+ +### MergeHighlightInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
annotationString
articleIdID!
idID!
overlapHighlightIdList[String!]!
patchString!
prefixString
quoteString!
shortIdID!
suffixString
+ +### PageInfoInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
authorString
canonicalUrlString
contentTypeString
descriptionString
previewImageString
publishedAtDate
titleString
+ +### PreparedDocumentInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
documentString!
pageInfoPageInfoInput!
+ +### ReportItemInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
itemUrlString!
pageIdID!
reportCommentString!
reportTypes[ReportType!]!
sharedByID
+ +### SaveArticleReadingProgressInput + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idID!
readingProgressAnchorIndexInt!
readingProgressPercentFloat!
+ +### SaveFileInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
clientRequestIdID!
sourceString!
uploadFileIdID!
urlString!
+ +### SavePageInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
clientRequestIdID!
originalContentString!
sourceString!
titleString
urlString!
+ +### SaveUrlInput + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
clientRequestIdID!
sourceString!
urlString!
+ +### SetBookmarkArticleInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
articleIDID!
bookmarkBoolean!
+ +### SetDeviceTokenInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idID
tokenString
+ +### SetFollowInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
followBoolean!
userIdID!
+ +### SetLabelsForHighlightInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
highlightIdID!
labelIds[ID!]!
+ +### SetLabelsInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
labelIds[ID!]!
pageIdID!
+ +### SetShareArticleInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
articleIDID!
shareBoolean!
sharedCommentString
sharedWithHighlightsBoolean
+ +### SetShareHighlightInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idID!
shareBoolean!
+ +### SetUserPersonalizationInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
fontFamilyString
fontSizeInt
libraryLayoutTypeString
librarySortOrderSortOrder
marginInt
themeString
+ +### SetWebhookInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
contentTypeString
enabledBoolean
eventTypes[WebhookEvent!]!
idID
methodString
urlString!
+ +### SignupInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
bioString
emailString!
nameString!
passwordString!
pictureUrlString
usernameString!
+ +### SortParams + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
bySortBy!
orderSortOrder
+ +### UpdateHighlightInput + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
annotationString
highlightIdID!
sharedAtDate
+ +### UpdateHighlightReplyInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
highlightReplyIdID!
textString!
+ +### UpdateLabelInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
colorString!
descriptionString
labelIdID!
nameString!
+ +### UpdateLinkShareInfoInput + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
descriptionString!
linkIdID!
titleString!
+ +### UpdatePageInput + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
descriptionString
pageIdID!
titleString
+ +### UpdateReminderInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
archiveUntilBoolean!
idID!
remindAtDate!
sendNotificationBoolean!
+ +### UpdateSharedCommentInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
articleIDID!
sharedCommentString!
+ +### UpdateUserInput + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
bioString
nameString!
+ +### UpdateUserProfileInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
bioString
pictureUrlString
userIdID!
usernameString
+ +### UploadFileRequestInput + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
clientRequestIdString
contentTypeString!
createPageEntryBoolean
urlString!
+ +## Enums + +### AddPopularReadErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### ApiKeysErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
UNAUTHORIZED
+ +### ArchiveLinkErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
UNAUTHORIZED
+ +### ArticleErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_DATA
NOT_FOUND
UNAUTHORIZED
+ +### ArticleSavingRequestErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
NOT_FOUND
UNAUTHORIZED
+ +### ArticleSavingRequestStatus + + + + + + + + + + + + + + + + + + + + +
ValueDescription
FAILED
PROCESSING
SUCCEEDED
+ +### ArticlesErrorCode + + + + + + + + + + + + +
ValueDescription
UNAUTHORIZED
+ +### ContentReader + + + + + + + + + + + + + + + + +
ValueDescription
PDF
WEB
+ +### CreateArticleErrorCode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
ELASTIC_ERROR
NOT_ALLOWED_TO_PARSE
PAYLOAD_TOO_LARGE
UNABLE_TO_FETCH
UNABLE_TO_PARSE
UNAUTHORIZED
UPLOAD_FILE_MISSING
+ +### CreateArticleSavingRequestErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
BAD_DATA
UNAUTHORIZED
+ +### CreateHighlightErrorCode + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
ALREADY_EXISTS
BAD_DATA
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
+ +### CreateHighlightReplyErrorCode + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
EMPTY_ANNOTATION
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
+ +### CreateLabelErrorCode + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
LABEL_ALREADY_EXISTS
NOT_FOUND
UNAUTHORIZED
+ +### CreateNewsletterEmailErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
UNAUTHORIZED
+ +### CreateReactionErrorCode + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_CODE
BAD_TARGET
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
+ +### CreateReminderErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### DeleteHighlightErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
+ +### DeleteHighlightReplyErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
+ +### DeleteLabelErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### DeleteNewsletterEmailErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### DeleteReactionErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
+ +### DeleteReminderErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### DeleteWebhookErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### FeedArticlesErrorCode + + + + + + + + + + + + +
ValueDescription
UNAUTHORIZED
+ +### GenerateApiKeyErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
ALREADY_EXISTS
BAD_REQUEST
UNAUTHORIZED
+ +### GetFollowersErrorCode + + + + + + + + + + + + +
ValueDescription
UNAUTHORIZED
+ +### GetFollowingErrorCode + + + + + + + + + + + + +
ValueDescription
UNAUTHORIZED
+ +### GetUserPersonalizationErrorCode + + + + + + + + + + + + +
ValueDescription
UNAUTHORIZED
+ +### LabelsErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### LogOutErrorCode + + + + + + + + + + + + +
ValueDescription
LOG_OUT_FAILED
+ +### LoginErrorCode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
ACCESS_DENIED
AUTH_FAILED
INVALID_CREDENTIALS
USER_ALREADY_EXISTS
USER_NOT_FOUND
WRONG_SOURCE
+ +### MergeHighlightErrorCode + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
ALREADY_EXISTS
BAD_DATA
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
+ +### NewsletterEmailsErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
UNAUTHORIZED
+ +### PageType + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
ARTICLE
BOOK
FILE
HIGHLIGHTS
PROFILE
UNKNOWN
WEBSITE
+ +### ReactionType + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
CRYING
HEART
HUSHED
LIKE
POUT
SMILE
+ +### ReminderErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### ReportType + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
ABUSIVE
CONTENT_DISPLAY
CONTENT_VIOLATION
SPAM
+ +### RevokeApiKeyErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### SaveArticleReadingProgressErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_DATA
NOT_FOUND
UNAUTHORIZED
+ +### SaveErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
UNAUTHORIZED
UNKNOWN
+ +### SearchErrorCode + + + + + + + + + + + + +
ValueDescription
UNAUTHORIZED
+ +### SendInstallInstructionsErrorCode + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
+ +### SetBookmarkArticleErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
BOOKMARK_EXISTS
NOT_FOUND
+ +### SetDeviceTokenErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### SetFollowErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
NOT_FOUND
UNAUTHORIZED
+ +### SetLabelsErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### SetShareArticleErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
NOT_FOUND
UNAUTHORIZED
+ +### SetShareHighlightErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
+ +### SetUserPersonalizationErrorCode + + + + + + + + + + + + +
ValueDescription
UNAUTHORIZED
+ +### SetWebhookErrorCode + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
ALREADY_EXISTS
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### SharedArticleErrorCode + + + + + + + + + + + + +
ValueDescription
NOT_FOUND
+ +### SignupErrorCode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
ACCESS_DENIED
EXPIRED_TOKEN
GOOGLE_AUTH_ERROR
INVALID_PASSWORD
INVALID_USERNAME
UNKNOWN
USER_EXISTS
+ +### SortBy + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
PUBLISHED_AT
SAVED_AT
SCORE
UPDATED_TIME
+ +### SortOrder + + + + + + + + + + + + + + + + +
ValueDescription
ASCENDING
DESCENDING
+ +### SubscribeErrorCode + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
ALREADY_SUBSCRIBED
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### SubscriptionStatus + + + + + + + + + + + + + + + + + + + + +
ValueDescription
ACTIVE
DELETED
UNSUBSCRIBED
+ +### SubscriptionsErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
UNAUTHORIZED
+ +### UnsubscribeErrorCode + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
ALREADY_UNSUBSCRIBED
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
UNSUBSCRIBE_METHOD_NOT_FOUND
+ +### UpdateHighlightErrorCode + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_DATA
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
+ +### UpdateHighlightReplyErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
+ +### UpdateLabelErrorCode + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
+ +### UpdateLinkShareInfoErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
UNAUTHORIZED
+ +### UpdatePageErrorCode + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
FORBIDDEN
NOT_FOUND
UNAUTHORIZED
UPDATE_FAILED
+ +### UpdateReminderErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### UpdateSharedCommentErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
NOT_FOUND
UNAUTHORIZED
+ +### UpdateUserErrorCode + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BIO_TOO_LONG
EMPTY_NAME
UNAUTHORIZED
USER_NOT_FOUND
+ +### UpdateUserProfileErrorCode + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_DATA
BAD_USERNAME
FORBIDDEN
UNAUTHORIZED
USERNAME_EXISTS
+ +### UploadFileRequestErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_INPUT
FAILED_CREATE
UNAUTHORIZED
+ +### UploadFileStatus + + + + + + + + + + + + + + + + +
ValueDescription
COMPLETED
INITIALIZED
+ +### UserErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
UNAUTHORIZED
USER_NOT_FOUND
+ +### UsersErrorCode + + + + + + + + + + + + +
ValueDescription
UNAUTHORIZED
+ +### WebhookErrorCode + + + + + + + + + + + + + + + + + + + + +
ValueDescription
BAD_REQUEST
NOT_FOUND
UNAUTHORIZED
+ +### WebhookEvent + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
HIGHLIGHT_CREATED
HIGHLIGHT_DELETED
HIGHLIGHT_UPDATED
LABEL_CREATED
LABEL_DELETED
LABEL_UPDATED
PAGE_CREATED
PAGE_DELETED
PAGE_UPDATED
+ +### WebhooksErrorCode + + + + + + + + + + + + + + + + +
ValueDescription
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](https://en.wikipedia.org/wiki/IEEE_floating_point). + +### 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 + + + + + + + + + + + + + + + + +
TypeDescription
AddPopularReadError
AddPopularReadSuccess
+ +### ApiKeysResult + + + + + + + + + + + + + + + + +
TypeDescription
ApiKeysError
ApiKeysSuccess
+ +### ArchiveLinkResult + + + + + + + + + + + + + + + + +
TypeDescription
ArchiveLinkError
ArchiveLinkSuccess
+ +### ArticleResult + + + + + + + + + + + + + + + + +
TypeDescription
ArticleError
ArticleSuccess
+ +### ArticleSavingRequestResult + + + + + + + + + + + + + + + + +
TypeDescription
ArticleSavingRequestError
ArticleSavingRequestSuccess
+ +### ArticlesResult + + + + + + + + + + + + + + + + +
TypeDescription
ArticlesError
ArticlesSuccess
+ +### CreateArticleResult + + + + + + + + + + + + + + + + +
TypeDescription
CreateArticleError
CreateArticleSuccess
+ +### CreateArticleSavingRequestResult + + + + + + + + + + + + + + + + +
TypeDescription
CreateArticleSavingRequestError
CreateArticleSavingRequestSuccess
+ +### CreateHighlightReplyResult + + + + + + + + + + + + + + + + +
TypeDescription
CreateHighlightReplyError
CreateHighlightReplySuccess
+ +### CreateHighlightResult + + + + + + + + + + + + + + + + +
TypeDescription
CreateHighlightError
CreateHighlightSuccess
+ +### CreateLabelResult + + + + + + + + + + + + + + + + +
TypeDescription
CreateLabelError
CreateLabelSuccess
+ +### CreateNewsletterEmailResult + + + + + + + + + + + + + + + + +
TypeDescription
CreateNewsletterEmailError
CreateNewsletterEmailSuccess
+ +### CreateReactionResult + + + + + + + + + + + + + + + + +
TypeDescription
CreateReactionError
CreateReactionSuccess
+ +### CreateReminderResult + + + + + + + + + + + + + + + + +
TypeDescription
CreateReminderError
CreateReminderSuccess
+ +### DeleteHighlightReplyResult + + + + + + + + + + + + + + + + +
TypeDescription
DeleteHighlightReplyError
DeleteHighlightReplySuccess
+ +### DeleteHighlightResult + + + + + + + + + + + + + + + + +
TypeDescription
DeleteHighlightError
DeleteHighlightSuccess
+ +### DeleteLabelResult + + + + + + + + + + + + + + + + +
TypeDescription
DeleteLabelError
DeleteLabelSuccess
+ +### DeleteNewsletterEmailResult + + + + + + + + + + + + + + + + +
TypeDescription
DeleteNewsletterEmailError
DeleteNewsletterEmailSuccess
+ +### DeleteReactionResult + + + + + + + + + + + + + + + + +
TypeDescription
DeleteReactionError
DeleteReactionSuccess
+ +### DeleteReminderResult + + + + + + + + + + + + + + + + +
TypeDescription
DeleteReminderError
DeleteReminderSuccess
+ +### DeleteWebhookResult + + + + + + + + + + + + + + + + +
TypeDescription
DeleteWebhookError
DeleteWebhookSuccess
+ +### FeedArticlesResult + + + + + + + + + + + + + + + + +
TypeDescription
FeedArticlesError
FeedArticlesSuccess
+ +### GenerateApiKeyResult + + + + + + + + + + + + + + + + +
TypeDescription
GenerateApiKeyError
GenerateApiKeySuccess
+ +### GetFollowersResult + + + + + + + + + + + + + + + + +
TypeDescription
GetFollowersError
GetFollowersSuccess
+ +### GetFollowingResult + + + + + + + + + + + + + + + + +
TypeDescription
GetFollowingError
GetFollowingSuccess
+ +### GetUserPersonalizationResult + + + + + + + + + + + + + + + + +
TypeDescription
GetUserPersonalizationError
GetUserPersonalizationSuccess
+ +### GoogleSignupResult + + + + + + + + + + + + + + + + +
TypeDescription
GoogleSignupError
GoogleSignupSuccess
+ +### LabelsResult + + + + + + + + + + + + + + + + +
TypeDescription
LabelsError
LabelsSuccess
+ +### LogOutResult + + + + + + + + + + + + + + + + +
TypeDescription
LogOutError
LogOutSuccess
+ +### LoginResult + + + + + + + + + + + + + + + + +
TypeDescription
LoginError
LoginSuccess
+ +### MergeHighlightResult + + + + + + + + + + + + + + + + +
TypeDescription
MergeHighlightError
MergeHighlightSuccess
+ +### NewsletterEmailsResult + + + + + + + + + + + + + + + + +
TypeDescription
NewsletterEmailsError
NewsletterEmailsSuccess
+ +### ReminderResult + + + + + + + + + + + + + + + + +
TypeDescription
ReminderError
ReminderSuccess
+ +### RevokeApiKeyResult + + + + + + + + + + + + + + + + +
TypeDescription
RevokeApiKeyError
RevokeApiKeySuccess
+ +### SaveArticleReadingProgressResult + + + + + + + + + + + + + + + + +
TypeDescription
SaveArticleReadingProgressError
SaveArticleReadingProgressSuccess
+ +### SaveResult + + + + + + + + + + + + + + + + +
TypeDescription
SaveError
SaveSuccess
+ +### SearchResult + + + + + + + + + + + + + + + + +
TypeDescription
SearchError
SearchSuccess
+ +### SendInstallInstructionsResult + + + + + + + + + + + + + + + + +
TypeDescription
SendInstallInstructionsError
SendInstallInstructionsSuccess
+ +### SetBookmarkArticleResult + + + + + + + + + + + + + + + + +
TypeDescription
SetBookmarkArticleError
SetBookmarkArticleSuccess
+ +### SetDeviceTokenResult + + + + + + + + + + + + + + + + +
TypeDescription
SetDeviceTokenError
SetDeviceTokenSuccess
+ +### SetFollowResult + + + + + + + + + + + + + + + + +
TypeDescription
SetFollowError
SetFollowSuccess
+ +### SetLabelsResult + + + + + + + + + + + + + + + + +
TypeDescription
SetLabelsError
SetLabelsSuccess
+ +### SetShareArticleResult + + + + + + + + + + + + + + + + +
TypeDescription
SetShareArticleError
SetShareArticleSuccess
+ +### SetShareHighlightResult + + + + + + + + + + + + + + + + +
TypeDescription
SetShareHighlightError
SetShareHighlightSuccess
+ +### SetUserPersonalizationResult + + + + + + + + + + + + + + + + +
TypeDescription
SetUserPersonalizationError
SetUserPersonalizationSuccess
+ +### SetWebhookResult + + + + + + + + + + + + + + + + +
TypeDescription
SetWebhookError
SetWebhookSuccess
+ +### SharedArticleResult + + + + + + + + + + + + + + + + +
TypeDescription
SharedArticleError
SharedArticleSuccess
+ +### SignupResult + + + + + + + + + + + + + + + + +
TypeDescription
SignupError
SignupSuccess
+ +### SubscribeResult + + + + + + + + + + + + + + + + +
TypeDescription
SubscribeError
SubscribeSuccess
+ +### SubscriptionsResult + + + + + + + + + + + + + + + + +
TypeDescription
SubscriptionsError
SubscriptionsSuccess
+ +### UnsubscribeResult + + + + + + + + + + + + + + + + +
TypeDescription
UnsubscribeError
UnsubscribeSuccess
+ +### UpdateHighlightReplyResult + + + + + + + + + + + + + + + + +
TypeDescription
UpdateHighlightReplyError
UpdateHighlightReplySuccess
+ +### UpdateHighlightResult + + + + + + + + + + + + + + + + +
TypeDescription
UpdateHighlightError
UpdateHighlightSuccess
+ +### UpdateLabelResult + + + + + + + + + + + + + + + + +
TypeDescription
UpdateLabelError
UpdateLabelSuccess
+ +### UpdateLinkShareInfoResult + + + + + + + + + + + + + + + + +
TypeDescription
UpdateLinkShareInfoError
UpdateLinkShareInfoSuccess
+ +### UpdatePageResult + + + + + + + + + + + + + + + + +
TypeDescription
UpdatePageError
UpdatePageSuccess
+ +### UpdateReminderResult + + + + + + + + + + + + + + + + +
TypeDescription
UpdateReminderError
UpdateReminderSuccess
+ +### UpdateSharedCommentResult + + + + + + + + + + + + + + + + +
TypeDescription
UpdateSharedCommentError
UpdateSharedCommentSuccess
+ +### UpdateUserProfileResult + + + + + + + + + + + + + + + + +
TypeDescription
UpdateUserProfileError
UpdateUserProfileSuccess
+ +### UpdateUserResult + + + + + + + + + + + + + + + + +
TypeDescription
UpdateUserError
UpdateUserSuccess
+ +### UploadFileRequestResult + + + + + + + + + + + + + + + + +
TypeDescription
UploadFileRequestError
UploadFileRequestSuccess
+ +### UserResult + + + + + + + + + + + + + + + + +
TypeDescription
UserError
UserSuccess
+ +### UsersResult + + + + + + + + + + + + + + + + +
TypeDescription
UsersError
UsersSuccess
+ +### WebhookResult + + + + + + + + + + + + + + + + +
TypeDescription
WebhookError
WebhookSuccess
+ +### WebhooksResult + + + + + + + + + + + + + + + + +
TypeDescription
WebhooksError
WebhooksSuccess
+Done in 0.36s.