lightyear

Home > @runlightyear/lightyear

lightyear package

Classes

Class	Description
HttpProxyResponseError

Abstract Classes

Abstract Class	Description
AppWebhookConnector
AuthConnector	Docs for AuthConnector
BaseConnector	The Base for all connectors.
GraphQLConnector	GraphQL Connector The base for making calls to GraphQL APIs
ModelConnector
OAuthConnector	OAuth2 Connector Creates the input to the 3 essential OAuth tasks: Generates a url to request an access token 2. Converts the oauth callback parameters into the https call to request an access token 3. Provides the https params to refresh an access token
RestConnector	Rest Connector The base for making calls to REST APIs
SmtpConnector	(ALPHA) Smtp Connector
SyncConnector

Functions

Function	Description
confirmChange(props)
confirmChangeBatch(props)
defineAction(props)	Define an Action
defineAuthorizer(props)
defineCollection(props)	(ALPHA)
defineCrmCollection(props)
defineCustomApp(props)	(BETA) Define a Custom App
defineIntegration(props)	(ALPHA)
defineOAuth(props)
defineSyncAction(props)
defineSyncIntegration(props)
defineWebhook(props)	Define a Webhook
deleteObject(props)
detectHardDeletes(props)
finishSync(syncId)
getCache(props)	(ALPHA)
getDeployList()
getModels(props)
isFunction(val)
isHttpProxyResponseError(error)
saveCache(props)	(ALPHA)
setSecret(name, value)	Set a secret on the current action or webhook.
setSubscriptionExpiresAt(value)
setVariable(name, value)	Set a variable on the current action or webhook.
sleep(delay)
upsertObject(props)
upsertObjectBatch(props)

Interfaces

Interface	Description
AppWebhookConnectorProps
AuthConnectorProps
Auths
BaseConnectorProps
BaseExternal
BaseObject
ConfirmChangeProps
CreateBatchProps
DefineActionProps
DefineAuthorizerProps
DefineCollectionProps	(ALPHA)
DefineCrmCollectionProps
DefineCustomAppApiKeyProps
DefineCustomAppBasicProps
DefineCustomAppOAuthProps
DefineIntegrationProps	(ALPHA)
DefineOAuthProps
DefineSyncActionProps
DefineSyncIntegrationProps
DefineWebhookProps
DeleteBatchProps
DeployFuncProps
DetectHardDeletesProps
GetCacheProps	(ALPHA)
GraphQLConnectorProps
GraphQLConnectorQueryProps
HttpProxyRequestProps
ListProps
ModelConnectorProps
OAuthConfigData
OAuthConnectorProps
Object_2
ObjectMeta
ReadProps
RefreshSubscriptionFuncProps
RestConnectorProps
RunFuncProps
SaveCacheProps	(ALPHA)
Secrets
SmtpConnectorProps	(ALPHA)
SmtpProxyRequestProps	(ALPHA)
SubscribeFuncProps
SyncConnectorProps
SynchronizerProps
UnsubscribeFuncProps
UpdateBatchProps
UpsertObjectProps
Variables
WebhookDeliveryData

Variables

Variable	Description
dayjsUtc
RERUN	This can be thrown inside a RunFunc to end execution tell the action to rerun. The action will be rerun with the same props as the original run.
SKIPPED	This can be thrown inside a RunFunc to end execution and mark the run as Skipped.

Type Aliases

Type Alias	Description
AppName
AppWebhookFunc	(BETA)
AuthType
CacheData	(ALPHA)
CrmAccountDataType
CrmAccountType
CrmCallDataType
CrmContactDataType
CrmContactType
CrmLeadDataType
CrmMeetingDataType
CrmNoteDataType
CrmOpportunityDataType
CrmOpportunityLineItemDataType
CrmProductDataType
CrmTaskDataType
CrmUserDataType
CrmUserType
DefineCustomAppProps
DeployFunc
EmailAddress
ExternalId
HttpProxyResponse
ObjectId
ObjectList
Prettify
RefreshSubscriptionFunc
RunFunc
SecretDef
SmtpProxyResponse	(ALPHA)
SubscribeFunc
SubscribePropsFunc
SubscribePropsFuncProps
UnsubscribeFunc
VariableDef