Type aliases
AdminTokenAuth
AdminTokenAuth: { adminToken: string; type: "adminToken" }
Type declaration
adminToken: string
type: "adminToken"
ApiTokenAuth
ApiTokenAuth: { apiToken: string | string[]; type: "apiToken" }
Type declaration
apiToken: string | string[]
type: "apiToken"
Auth
Data
HttpMethod
HttpMethod: "get" | "post" | "put" | "delete"
HttpResponse
HttpResponse<T>: { data: T; headers: any }
Type parameters
JournalParam
Journal
Param
: { content
: string; keepRaw
?: boolean; sourceContent
: string; type
: JournalType }Type declaration
content: string
Optional keepRaw?: boolean
sourceContent: string
MFAType
MFAType: "NONE" | "TFA_TOTP"
ModeType
ModeType: "PRODUCTION" | "DEVELOPMENT" | "DEMO" | "TEST"
MultiFactorAuth
MultiFactorAuth: { mfaKey: string; mfaType: string; optAuthUrl: string; qrImage: string }
Type declaration
mfaKey: string
mfaType: string
optAuthUrl: string
qrImage: string
OAuthTokenAuth
OAuthTokenAuth: { oAuthToken: string; type: "oAuthToken" }
Type declaration
oAuthToken: string
type: "oAuthToken"
OmitTypePropertyFromUnion
OmitTypePropertyFromUnion<T>: T extends unknown ? Omit<T, "type"> : never
Type parameters
Option
Option
: { id
?: number; key
: string; type
?: OptionType; value
?: any }Type declaration
Optional id?: number
key: string
Optional value?: any
Options
Options
: { auth
?: <internal>.Auth; baseUrl
?: string; basicAuth
?: BasicAuth; clientCertAuth
?: { password
: string; pfx
: Buffer } | { password
: string; pfxFilePath
: string }; proxy
?: <internal>.ProxyConfig; userAgent
?: string }Type declaration
Optional baseUrl?: string
Optional basicAuth?: BasicAuth
Optional clientCertAuth?: { password: string; pfx: Buffer } | { password: string; pfxFilePath: string }
Optional userAgent?: string
Params
Params: {}
PasswordAuth
PasswordAuth: { password: string; type: "password"; username: string }
Type declaration
password: string
type: "password"
username: string
ProxyConfig
ProxyConfig: { auth?: { password: string; username: string }; host: string; port: number }
Type declaration
Optional auth?: { password: string; username: string }
password: string
username: string
host: string
port: number
SessionAuth
SessionAuth: { type: "session" }
commentTargets
commentTargets: "posts" | "sheets" | "journals"