@nishans/endpoints / Exports

@nishans/endpoints

Index

Classes

• Cache
• Mutations
• Queries

Interfaces

• Configs
• CtorArgs
• ICache
• NotionHeaders

Type aliases

• UpdateCacheManuallyParam

Functions

• createSpace
• createTransaction
• enqueueTask
• findUser
• getBacklinksForBlock
• getGenericEmbedBlockData
• getGoogleDriveAccounts
• getJoinableSpaces
• getPageVisits
• getPublicPageData
• getPublicSpaceData
• getSpaces
• getSubscriptionData
• getTasks
• getUploadFileUrl
• getUserNotifications
• getUserSharedPages
• getUserTasks
• initializeGoogleDriveBlock
• initializePageTemplate
• inviteGuestsToSpace
• isEmailEducation
• isUserDomainJoinable
• loadBlockSubtree
• loadPageChunk
• loadUserContent
• queryCollection
• recordPageVisit
• removeUsersFromSpace
• saveTransactions
• sendRequest
• setBookmarkMetadata
• setPageNotificationsAsRead
• setSpaceNotificationsAsRead
• syncRecordValues

Type aliases

UpdateCacheManuallyParam

Ƭ UpdateCacheManuallyParam: (string | [string, TDataType])[]

Defined in: src/types.ts:13

Functions

createSpace

▸ createSpace(params: CreateSpaceParams, configs: Configs): Promise<CreateSpaceResult>

Parameters:

Name	Type
params	CreateSpaceParams
configs	Configs

Returns: Promise<CreateSpaceResult>

Defined in: utils/mutations.ts:38

---

createTransaction

▸ createTransaction(shardId: number, spaceId: string, operations: IOperation[]): SaveTransactionParams

Parameters:

Name	Type
shardId	number
spaceId	string
operations	IOperation[]

Returns: SaveTransactionParams

Defined in: utils/createTransaction.ts:5

---

enqueueTask

▸ enqueueTask(params: EnqueueTaskParams, configs: Configs): Promise<EnqueueTaskResult>

Parameters:

Name	Type
params	EnqueueTaskParams
configs	Configs

Returns: Promise<EnqueueTaskResult>

Defined in: utils/mutations.ts:46

---

findUser

▸ findUser(params: FindUserParams, configs: Configs): Promise<FindUserResult>

Parameters:

Name	Type
params	FindUserParams
configs	Configs

Returns: Promise<FindUserResult>

Defined in: utils/queries.ts:93

---

getBacklinksForBlock

▸ getBacklinksForBlock(params: GetBackLinksForBlockParams, configs: Configs): Promise<GetBackLinksForBlockResult>

Parameters:

Name	Type
params	GetBackLinksForBlockParams
configs	Configs

Returns: Promise<GetBackLinksForBlockResult>

Defined in: utils/queries.ts:89

---

getGenericEmbedBlockData

▸ getGenericEmbedBlockData(params: GetGenericEmbedBlockDataParams, configs: Configs): Promise<GetGenericEmbedBlockDataResult>

Parameters:

Name	Type
params	GetGenericEmbedBlockDataParams
configs	Configs

Returns: Promise<GetGenericEmbedBlockDataResult>

Defined in: utils/queries.ts:77

---

getGoogleDriveAccounts

▸ getGoogleDriveAccounts(configs: Configs): Promise<GetGoogleDriveAccountsResult>

Parameters:

Name	Type
configs	Configs

Returns: Promise<GetGoogleDriveAccountsResult>

Defined in: utils/queries.ts:85

---

getJoinableSpaces

▸ getJoinableSpaces(configs: Configs): Promise<GetJoinableSpacesResult>

Parameters:

Name	Type
configs	Configs

Returns: Promise<GetJoinableSpacesResult>

Defined in: utils/queries.ts:117

---

getPageVisits

▸ getPageVisits(params: GetPageVisitsParams, configs: Configs): Promise<GetPageVisitsResult>

Parameters:

Name	Type
params	GetPageVisitsParams
configs	Configs

Returns: Promise<GetPageVisitsResult>

Defined in: utils/queries.ts:45

---

getPublicPageData

▸ getPublicPageData(params: GetPublicPageDataParams, configs: Configs): Promise<GetPublicPageDataResult>

Parameters:

Name	Type
params	GetPublicPageDataParams
configs	Configs

Returns: Promise<GetPublicPageDataResult>

Defined in: utils/queries.ts:57

---

getPublicSpaceData

▸ getPublicSpaceData(params: GetPublicSpaceDataParams, configs: Configs): Promise<GetPublicSpaceDataResult>

Parameters:

Name	Type
params	GetPublicSpaceDataParams
configs	Configs

Returns: Promise<GetPublicSpaceDataResult>

Defined in: utils/queries.ts:61

---

getSpaces

▸ getSpaces(configs: Configs): Promise<GetSpacesResult>

Parameters:

Name	Type
configs	Configs

Returns: Promise<GetSpacesResult>

Defined in: utils/queries.ts:73

---

getSubscriptionData

▸ getSubscriptionData(params: GetSubscriptionDataParams, configs: Configs): Promise<GetSubscriptionDataResult>

Parameters:

Name	Type
params	GetSubscriptionDataParams
configs	Configs

Returns: Promise<GetSubscriptionDataResult>

Defined in: utils/queries.ts:65

---

getTasks

▸ getTasks(params: GetTasksParams, configs: Configs): Promise<GetTasksResult>

Parameters:

Name	Type
params	GetTasksParams
configs	Configs

Returns: Promise<GetTasksResult>

Defined in: utils/queries.ts:133

---

getUploadFileUrl

▸ getUploadFileUrl(params: GetUploadFileUrlParams, configs: Configs): Promise<GetUploadFileUrlResult>

Parameters:

Name	Type
params	GetUploadFileUrlParams
configs	Configs

Returns: Promise<GetUploadFileUrlResult>

Defined in: utils/queries.ts:81

---

getUserNotifications

▸ getUserNotifications(params: GetUserNotificationsParams, configs: Configs): Promise<GetUserNotificationsResult>

Parameters:

Name	Type
params	GetUserNotificationsParams
configs	Configs

Returns: Promise<GetUserNotificationsResult>

Defined in: utils/queries.ts:129

---

getUserSharedPages

▸ getUserSharedPages(params: GetUserSharedPagesParams, configs: Configs): Promise<GetUserSharedPagesResult>

Parameters:

Name	Type
params	GetUserSharedPagesParams
configs	Configs

Returns: Promise<GetUserSharedPagesResult>

Defined in: utils/queries.ts:49

---

getUserTasks

▸ getUserTasks(configs: Configs): Promise<GetUserTasksResult>

Parameters:

Name	Type
configs	Configs

Returns: Promise<GetUserTasksResult>

Defined in: utils/queries.ts:53

---

initializeGoogleDriveBlock

▸ initializeGoogleDriveBlock(params: InitializeGoogleDriveBlockParams, configs: Configs): Promise<InitializeGoogleDriveBlockResult>

Parameters:

Name	Type
params	InitializeGoogleDriveBlockParams
configs	Configs

Returns: Promise<InitializeGoogleDriveBlockResult>

Defined in: utils/mutations.ts:58

---

initializePageTemplate

▸ initializePageTemplate(params: InitializePageTemplateParams, configs: Configs): Promise<InitializePageTemplateResult>

Parameters:

Name	Type
params	InitializePageTemplateParams
configs	Configs

Returns: Promise<InitializePageTemplateResult>

Defined in: utils/mutations.ts:54

---

inviteGuestsToSpace

▸ inviteGuestsToSpace(params: InviteGuestsToSpaceParams, configs: Configs): Promise<unknown>

Parameters:

Name	Type
params	InviteGuestsToSpaceParams
configs	Configs

Returns: Promise<unknown>

Defined in: utils/mutations.ts:34

---

isEmailEducation

▸ isEmailEducation(configs: Configs): Promise<IsEmailEducationResult>

Parameters:

Name	Type
configs	Configs

Returns: Promise<IsEmailEducationResult>

Defined in: utils/queries.ts:125

---

isUserDomainJoinable

▸ isUserDomainJoinable(configs: Configs): Promise<IsUserDomainJoinableResult>

Parameters:

Name	Type
configs	Configs

Returns: Promise<IsUserDomainJoinableResult>

Defined in: utils/queries.ts:121

---

loadBlockSubtree

▸ loadBlockSubtree(params: LoadBlockSubtreeParams, configs: Configs): Promise<LoadBlockSubtreeResult>

Parameters:

Name	Type
params	LoadBlockSubtreeParams
configs	Configs

Returns: Promise<LoadBlockSubtreeResult>

Defined in: utils/queries.ts:69

---

loadPageChunk

▸ loadPageChunk(params: LoadPageChunkParams, configs: Configs): Promise<LoadPageChunkResult>

Parameters:

Name	Type
params	LoadPageChunkParams
configs	Configs

Returns: Promise<LoadPageChunkResult>

Defined in: utils/queries.ts:109

---

loadUserContent

▸ loadUserContent(configs: Configs): Promise<LoadUserContentResult>

Parameters:

Name	Type
configs	Configs

Returns: Promise<LoadUserContentResult>

Defined in: utils/queries.ts:105

---

queryCollection

▸ queryCollection(params: QueryCollectionParams, configs: Configs): Promise<QueryCollectionResult>

Parameters:

Name	Type
params	QueryCollectionParams
configs	Configs

Returns: Promise<QueryCollectionResult>

Defined in: utils/queries.ts:101

---

recordPageVisit

▸ recordPageVisit(params: RecordPageVisitParams, configs: Configs): Promise<GetPageVisitsResult>

Parameters:

Name	Type
params	RecordPageVisitParams
configs	Configs

Returns: Promise<GetPageVisitsResult>

Defined in: utils/queries.ts:113

---

removeUsersFromSpace

▸ removeUsersFromSpace(params: RemoveUsersFromSpaceParams, configs: Configs): Promise<RemoveUsersFromSpaceResult>

Parameters:

Name	Type
params	RemoveUsersFromSpaceParams
configs	Configs

Returns: Promise<RemoveUsersFromSpaceResult>

Defined in: utils/mutations.ts:30

---

saveTransactions

▸ saveTransactions(params: SaveTransactionParams, configs: Configs): Promise<unknown>

Parameters:

Name	Type
params	SaveTransactionParams
configs	Configs

Returns: Promise<unknown>

Defined in: utils/mutations.ts:42

---

sendRequest

▸ ConstsendRequest<T>(url: string, arg: any, configs: Configs): Promise<T>

Type parameters:

Name
T

Parameters:

Name	Type
url	string
arg	any
configs	Configs

Returns: Promise<T>

Defined in: utils/sendRequest.ts:28

---

setBookmarkMetadata

▸ setBookmarkMetadata(params: SetBookmarkMetadataParams, configs: Configs): Promise<unknown>

Parameters:

Name	Type
params	SetBookmarkMetadataParams
configs	Configs

Returns: Promise<unknown>

Defined in: utils/mutations.ts:50

---

setPageNotificationsAsRead

▸ setPageNotificationsAsRead(params: SetPageNotificationsAsReadParams, configs: Configs): Promise<unknown>

Parameters:

Name	Type
params	SetPageNotificationsAsReadParams
configs	Configs

Returns: Promise<unknown>

Defined in: utils/mutations.ts:22

---

setSpaceNotificationsAsRead

▸ setSpaceNotificationsAsRead(params: SetSpaceNotificationsAsReadParams, configs: Configs): Promise<unknown>

Parameters:

Name	Type
params	SetSpaceNotificationsAsReadParams
configs	Configs

Returns: Promise<unknown>

Defined in: utils/mutations.ts:26

---

syncRecordValues

▸ syncRecordValues(params: SyncRecordValuesParams, configs: Configs): Promise<SyncRecordValuesResult>

Parameters:

Name	Type
params	SyncRecordValuesParams
configs	Configs

Returns: Promise<SyncRecordValuesResult>

Defined in: utils/queries.ts:97