WarmHubClient
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WarmHubClient(
apiUrl?,options?):WarmHubClient
Parameters
Section titled “Parameters”apiUrl?
Section titled “apiUrl?”string
options?
Section titled “options?”Returns
Section titled “Returns”WarmHubClient
Constructor
Section titled “Constructor”new WarmHubClient(
options?):WarmHubClient
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”WarmHubClient
Properties
Section titled “Properties”apiUrl
Section titled “apiUrl”
readonlyapiUrl:string
readonlyauth:object
getClientId
Section titled “getClientId”getClientId: () =>
Promise<string>
Returns
Section titled “Returns”Promise<string>
sync: () =>
Promise<AuthSyncResult>
Returns
Section titled “Returns”Promise<AuthSyncResult>
currentUser
Section titled “currentUser”currentUser: () =>
Promise<CurrentUserInfo>
Returns
Section titled “Returns”Promise<CurrentUserInfo>
access
Section titled “access”
readonlyaccess:object
checkRepoPermission
Section titled “checkRepoPermission”checkRepoPermission: (
orgName,repoName,permission) =>Promise<boolean>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
permission
Section titled “permission”string
Returns
Section titled “Returns”Promise<boolean>
checkOrgPermission
Section titled “checkOrgPermission”checkOrgPermission: (
orgName,permission) =>Promise<boolean>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
permission
Section titled “permission”string
Returns
Section titled “Returns”Promise<boolean>
diagnostics
Section titled “diagnostics”
readonlydiagnostics:object
ping: () =>
Promise<PingResult>
Returns
Section titled “Returns”Promise<PingResult>
capabilities
Section titled “capabilities”capabilities: () =>
Promise<Capabilities>
Returns
Section titled “Returns”Promise<Capabilities>
component
Section titled “component”
readonlycomponent:object
list: (
orgName,repoName,opts?) =>Promise<ComponentListResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<ComponentListResult>
get: (
orgName,repoName,componentId,opts?) =>Promise<ComponentDetail>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
componentId
Section titled “componentId”string
Returns
Section titled “Returns”Promise<ComponentDetail>
commit
Section titled “commit”
readonlycommit:object
apply: (
orgName,repoName,author,message,operations,opts?) =>Promise<CommitApplyResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
author
Section titled “author”string
message
Section titled “message”string | undefined
operations
Section titled “operations”workspaceName?
Section titled “workspaceName?”string
componentId?
Section titled “componentId?”string
chunkSize?
Section titled “chunkSize?”number
Returns
Section titled “Returns”Promise<CommitApplyResult>
log: (
orgName,repoName,opts?) =>Promise<LogResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<LogResult>
readonlyorg:object
get: (
orgName) =>Promise<Org>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
Returns
Section titled “Returns”Promise<Org>
getCallerRole
Section titled “getCallerRole”getCallerRole: (
orgName) =>Promise<"owner"|"admin"|"editor"|"viewer"|null>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
Returns
Section titled “Returns”Promise<"owner" | "admin" | "editor" | "viewer" | null>
list: (
opts?) =>Promise<Page<Org>>
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Page<Org>>
create
Section titled “create”create: (
name,displayName?,description?) =>Promise<Org>
Parameters
Section titled “Parameters”string
displayName?
Section titled “displayName?”string
description?
Section titled “description?”string
Returns
Section titled “Returns”Promise<Org>
setDescription
Section titled “setDescription”setDescription: (
orgName,description?) =>Promise<Org>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
description?
Section titled “description?”string
Returns
Section titled “Returns”Promise<Org>
rename
Section titled “rename”rename: (
orgName,newName) =>Promise<Org>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
newName
Section titled “newName”string
Returns
Section titled “Returns”Promise<Org>
addMember
Section titled “addMember”addMember: (
orgName,role) =>Promise<OrgMember>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
string
"owner" | "admin" | "editor" | "viewer"
Returns
Section titled “Returns”Promise<OrgMember>
removeMember
Section titled “removeMember”removeMember: (
orgName,Promise<void>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
string
Returns
Section titled “Returns”Promise<void>
changeMemberRole
Section titled “changeMemberRole”changeMemberRole: (
orgName,role) =>Promise<OrgMember>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
string
"owner" | "admin" | "editor" | "viewer"
Returns
Section titled “Returns”Promise<OrgMember>
setMemberScopes
Section titled “setMemberScopes”setMemberScopes: (
orgName,scopes) =>Promise<void>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
string
scopes
Section titled “scopes”Returns
Section titled “Returns”Promise<void>
clearMemberScopes
Section titled “clearMemberScopes”clearMemberScopes: (
orgName,Promise<void>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
string
Returns
Section titled “Returns”Promise<void>
listMembers
Section titled “listMembers”listMembers: (
orgName,opts?) =>Promise<OrgMemberList>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
Returns
Section titled “Returns”Promise<OrgMemberList>
archive
Section titled “archive”archive: (
orgName) =>Promise<Org>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
Returns
Section titled “Returns”Promise<Org>
unarchive
Section titled “unarchive”unarchive: (
orgName) =>Promise<Org>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
Returns
Section titled “Returns”Promise<Org>
readonlyrepo:object
get: (
orgName,repoName) =>Promise<Repo>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<Repo>
getStats
Section titled “getStats”getStats: (
orgName,repoName) =>Promise<RepoStats>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<RepoStats>
getConfigureStats
Section titled “getConfigureStats”getConfigureStats: (
orgName,repoName) =>Promise<RepoConfigureStats>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<RepoConfigureStats>
list: (
orgName,opts?) =>Promise<RepoListResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
Returns
Section titled “Returns”Promise<RepoListResult>
create
Section titled “create”create: (
orgName,repoName,description?,visibility?) =>Promise<Repo>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
description?
Section titled “description?”string
visibility?
Section titled “visibility?”RepoVisibility
Returns
Section titled “Returns”Promise<Repo>
setDescription
Section titled “setDescription”setDescription: (
orgName,repoName,description?) =>Promise<Repo>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
description?
Section titled “description?”string
Returns
Section titled “Returns”Promise<Repo>
setVisibility
Section titled “setVisibility”setVisibility: (
orgName,repoName,visibility) =>Promise<Repo>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
visibility
Section titled “visibility”RepoVisibility
Returns
Section titled “Returns”Promise<Repo>
rename
Section titled “rename”rename: (
orgName,repoName,newName) =>Promise<Repo>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
newName
Section titled “newName”string
Returns
Section titled “Returns”Promise<Repo>
archive
Section titled “archive”archive: (
orgName,repoName) =>Promise<Repo>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<Repo>
unarchive
Section titled “unarchive”unarchive: (
orgName,repoName) =>Promise<Repo>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<Repo>
listPage
Section titled “listPage”listPage: (
orgName,opts?) =>Promise<RepoListPageResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
Returns
Section titled “Returns”Promise<RepoListPageResult>
getReadme
Section titled “getReadme”getReadme: (
orgName,repoName) =>Promise<ThingDetail|null>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<ThingDetail | null>
readonlyshape:object
list: (
orgName,repoName,opts?) =>Promise<ShapeListResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<ShapeListResult>
get: (
orgName,repoName,shapeName,opts?) =>Promise<ShapeGetResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
shapeName
Section titled “shapeName”string
Returns
Section titled “Returns”Promise<ShapeGetResult>
create
Section titled “create”create: (
orgName,repoName,shapeName,fields,opts?) =>Promise<ShapeChangeResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
shapeName
Section titled “shapeName”string
fields
Section titled “fields”Record<string, unknown>
Returns
Section titled “Returns”Promise<ShapeChangeResult>
revise
Section titled “revise”revise: (
orgName,repoName,shapeName,newFields,opts?) =>Promise<ShapeChangeResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
shapeName
Section titled “shapeName”string
newFields
Section titled “newFields”Record<string, unknown>
Returns
Section titled “Returns”Promise<ShapeChangeResult>
remove
Section titled “remove”remove: (
orgName,repoName,shapeName) =>Promise<ShapeRemoveResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
shapeName
Section titled “shapeName”string
Returns
Section titled “Returns”Promise<ShapeRemoveResult>
rename
Section titled “rename”rename: (
orgName,repoName,oldName,newName) =>Promise<RenameResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
oldName
Section titled “oldName”string
newName
Section titled “newName”string
Returns
Section titled “Returns”Promise<RenameResult>
subscription
Section titled “subscription”
readonlysubscription:object
create
Section titled “create”create: (
input) =>Promise<SubscriptionInfo>
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<SubscriptionInfo>
get: (
orgName,repoName,name) =>Promise<SubscriptionInfo>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
Returns
Section titled “Returns”Promise<SubscriptionInfo>
list: (
orgName,repoName) =>Promise<SubscriptionList>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<SubscriptionList>
update
Section titled “update”update: (
input) =>Promise<SubscriptionInfo>
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<SubscriptionInfo>
pause: (
orgName,repoName,name) =>Promise<{name:string;active:boolean; }>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
Returns
Section titled “Returns”Promise<{ name: string; active: boolean; }>
resume
Section titled “resume”resume: (
orgName,repoName,name) =>Promise<{name:string;active:boolean; }>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
Returns
Section titled “Returns”Promise<{ name: string; active: boolean; }>
remove
Section titled “remove”remove: (
orgName,repoName,name) =>Promise<{ok:true; }>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
Returns
Section titled “Returns”Promise<{ ok: true; }>
bindCredentials
Section titled “bindCredentials”bindCredentials: (
orgName,repoName,subscriptionName,credentialSetName) =>Promise<SubscriptionBindCredentialsResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
credentialSetName
Section titled “credentialSetName”string
Returns
Section titled “Returns”Promise<SubscriptionBindCredentialsResult>
unbindCredentials
Section titled “unbindCredentials”unbindCredentials: (
orgName,repoName,subscriptionName) =>Promise<SubscriptionUnbindCredentialsResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
Returns
Section titled “Returns”Promise<SubscriptionUnbindCredentialsResult>
action
Section titled “action”
readonlyaction:object
acquireLease
Section titled “acquireLease”acquireLease: (
orgName,repoName,subscriptionName,holderId,holderType,opts?) =>Promise<ActionLeaseAcquire>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
holderId
Section titled “holderId”string
holderType
Section titled “holderType”"sdk" | "sprite" | "cli"
graceMs?
Section titled “graceMs?”number
ttlMs?
Section titled “ttlMs?”number
Returns
Section titled “Returns”Promise<ActionLeaseAcquire>
heartbeatLease
Section titled “heartbeatLease”heartbeatLease: (
orgName,repoName,subscriptionName,holderId,ttlMs?) =>Promise<ActionLeaseOp>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
holderId
Section titled “holderId”string
ttlMs?
Section titled “ttlMs?”number
Returns
Section titled “Returns”Promise<ActionLeaseOp>
releaseLease
Section titled “releaseLease”releaseLease: (
orgName,repoName,subscriptionName,holderId) =>Promise<ActionLeaseOp>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
holderId
Section titled “holderId”string
Returns
Section titled “Returns”Promise<ActionLeaseOp>
claimDelivery
Section titled “claimDelivery”claimDelivery: (
orgName,repoName,subscriptionName,commitId,holderId) =>Promise<ActionLeaseOp>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
commitId
Section titled “commitId”string
holderId
Section titled “holderId”string
Returns
Section titled “Returns”Promise<ActionLeaseOp>
completeDelivery
Section titled “completeDelivery”completeDelivery: (
orgName,repoName,subscriptionName,commitId,holderId) =>Promise<ActionLeaseOp>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
commitId
Section titled “commitId”string
holderId
Section titled “holderId”string
Returns
Section titled “Returns”Promise<ActionLeaseOp>
liveFeed
Section titled “liveFeed”liveFeed: (
orgName,repoName,subscriptionName,opts?) =>Promise<ActionLiveFeedResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
Returns
Section titled “Returns”Promise<ActionLiveFeedResult>
listRuns
Section titled “listRuns”listRuns: (
orgName,repoName,opts?) =>Promise<ActionRun[]>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<ActionRun[]>
getRunAttempts
Section titled “getRunAttempts”getRunAttempts: (
orgName,repoName,subscriptionName,commitId) =>Promise<ActionAttempt[]>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
commitId
Section titled “commitId”string
Returns
Section titled “Returns”Promise<ActionAttempt[]>
listNotifications
Section titled “listNotifications”listNotifications: (
orgName,repoName,opts?) =>Promise<ActionNotification[]>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
ActionListNotificationsOptions
Returns
Section titled “Returns”Promise<ActionNotification[]>
readonlything:object
head: (
orgName,repoName,opts?) =>Promise<HeadResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<HeadResult>
get: (
orgName,repoName,wref,version?,opts?) =>Promise<ThingDetail>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
version?
Section titled “version?”number
Returns
Section titled “Returns”Promise<ThingDetail>
getMany
Section titled “getMany”getMany: (
orgName,repoName,wrefs,version?,opts?) =>Promise<ThingGetManyResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string[]
version?
Section titled “version?”number
workspaceName?
Section titled “workspaceName?”string
Returns
Section titled “Returns”Promise<ThingGetManyResult>
history
Section titled “history”history: (
orgName,repoName,opts) =>Promise<HistoryResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<HistoryResult>
rename
Section titled “rename”rename: (
orgName,repoName,shapeName,oldName,newName) =>Promise<RenameResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
shapeName
Section titled “shapeName”string
oldName
Section titled “oldName”string
newName
Section titled “newName”string
Returns
Section titled “Returns”Promise<RenameResult>
resolve
Section titled “resolve”resolve: (
orgName,repoName,wref,opts?) =>Promise<ThingDetail>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
workspaceName?
Section titled “workspaceName?”string
Returns
Section titled “Returns”Promise<ThingDetail>
about: (
orgName,repoName,wref,opts?) =>Promise<AboutResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
Returns
Section titled “Returns”Promise<AboutResult>
query: (
orgName,repoName,opts?) =>Promise<HeadResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<HeadResult>
search
Section titled “search”search: (
orgName,repoName,query,opts?) =>Promise<HeadResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
Returns
Section titled “Returns”Promise<HeadResult>
count: (
orgName,repoName,opts?) =>Promise<CountResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<CountResult>
refs: (
orgName,repoName,wref,opts?) =>Promise<RefsResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
Returns
Section titled “Returns”Promise<RefsResult>
readonlylive:object
thingHead
Section titled “thingHead”thingHead: (
orgName,repoName,opts,onUpdate) =>Promise<LiveHandle>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
LiveThingHeadOptions | undefined
onUpdate
Section titled “onUpdate”(result) => void | Promise<void>
Returns
Section titled “Returns”Promise<LiveHandle>
thingHistory
Section titled “thingHistory”thingHistory: (
orgName,repoName,opts,onUpdate) =>Promise<LiveHandle>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
onUpdate
Section titled “onUpdate”(result) => void | Promise<void>
Returns
Section titled “Returns”Promise<LiveHandle>
subscriptionLog
Section titled “subscriptionLog”subscriptionLog: (
orgName,repoName,subscriptionName,opts,onUpdate) =>Promise<LiveHandle>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
LiveSubscriptionLogOptions | undefined
onUpdate
Section titled “onUpdate”(result) => void | Promise<void>
Returns
Section titled “Returns”Promise<LiveHandle>
workspace
Section titled “workspace”
readonlyworkspace:object
create
Section titled “create”create: (
orgName,repoName,name,description?) =>Promise<WorkspaceRef>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
description?
Section titled “description?”string
Returns
Section titled “Returns”Promise<WorkspaceRef>
list: (
orgName,repoName,opts?) =>Promise<WorkspaceList>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<WorkspaceList>
get: (
orgName,repoName,workspaceName) =>Promise<WorkspaceDetail>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
workspaceName
Section titled “workspaceName”string
Returns
Section titled “Returns”Promise<WorkspaceDetail>
remove
Section titled “remove”remove: (
orgName,repoName,workspaceName) =>Promise<WorkspaceRemoveResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
workspaceName
Section titled “workspaceName”string
Returns
Section titled “Returns”Promise<WorkspaceRemoveResult>
revert
Section titled “revert”revert: (
orgName,repoName,workspaceName,wref) =>Promise<WorkspaceRevertResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
workspaceName
Section titled “workspaceName”string
string
Returns
Section titled “Returns”Promise<WorkspaceRevertResult>
discard
Section titled “discard”discard: (
orgName,repoName,workspaceName,wref) =>Promise<WorkspaceDiscardResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
workspaceName
Section titled “workspaceName”string
string
Returns
Section titled “Returns”Promise<WorkspaceDiscardResult>
status
Section titled “status”status: (
orgName,repoName,workspaceName) =>Promise<WorkspaceStatusResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
workspaceName
Section titled “workspaceName”string
Returns
Section titled “Returns”Promise<WorkspaceStatusResult>
validate
Section titled “validate”validate: (
orgName,repoName,workspaceName) =>Promise<WorkspaceValidateResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
workspaceName
Section titled “workspaceName”string
Returns
Section titled “Returns”Promise<WorkspaceValidateResult>
rebase
Section titled “rebase”rebase: (
orgName,repoName,workspaceName) =>Promise<WorkspaceRebaseResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
workspaceName
Section titled “workspaceName”string
Returns
Section titled “Returns”Promise<WorkspaceRebaseResult>
readonlytoken:object
create
Section titled “create”create: (
input) =>Promise<TokenCreateResult>
Parameters
Section titled “Parameters”TokenCreateInput
Returns
Section titled “Returns”Promise<TokenCreateResult>
list: () =>
Promise<TokenInfo[]>
Returns
Section titled “Returns”Promise<TokenInfo[]>
get: (
name) =>Promise<TokenInfo|null>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<TokenInfo | null>
revoke
Section titled “revoke”revoke: (
name) =>Promise<TokenRevokeResult>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<TokenRevokeResult>
ingest
Section titled “ingest”
readonlyingest:object
begin: (
input) =>Promise<IngestBeginResult>
Parameters
Section titled “Parameters”IngestBeginInput
Returns
Section titled “Returns”Promise<IngestBeginResult>
append
Section titled “append”append: (
input) =>Promise<IngestAppendResult>
Parameters
Section titled “Parameters”IngestAppendInput
Returns
Section titled “Returns”Promise<IngestAppendResult>
finalize
Section titled “finalize”finalize: (
input) =>Promise<IngestFinalizeResult>
Parameters
Section titled “Parameters”IngestFinalizeInput
Returns
Section titled “Returns”Promise<IngestFinalizeResult>
status
Section titled “status”status: (
input) =>Promise<IngestStatusResult>
Parameters
Section titled “Parameters”IngestStatusInput
Returns
Section titled “Returns”Promise<IngestStatusResult>
credential
Section titled “credential”
readonlycredential:object
createSet
Section titled “createSet”createSet: (
orgName,repoName,name,opts?) =>Promise<CredentialInfo>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
scope?
Section titled “scope?”"repo" | "org"
description?
Section titled “description?”string
Returns
Section titled “Returns”Promise<CredentialInfo>
listSets
Section titled “listSets”listSets: (
orgName,repoName) =>Promise<CredentialInfo[]>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<CredentialInfo[]>
getSet
Section titled “getSet”getSet: (
orgName,repoName,name) =>Promise<CredentialInfo>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
Returns
Section titled “Returns”Promise<CredentialInfo>
setKey
Section titled “setKey”setKey: (
orgName,repoName,setName,keyName,value) =>Promise<CredentialKeyMutationResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
keyName
Section titled “keyName”string
string
Returns
Section titled “Returns”Promise<CredentialKeyMutationResult>
setKeys
Section titled “setKeys”setKeys: (
orgName,repoName,setName,secrets) =>Promise<CredentialKeyMutationResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
secrets
Section titled “secrets”Record<string, string>
Returns
Section titled “Returns”Promise<CredentialKeyMutationResult>
unsetKey
Section titled “unsetKey”unsetKey: (
orgName,repoName,setName,keyName) =>Promise<CredentialKeyMutationResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
keyName
Section titled “keyName”string
Returns
Section titled “Returns”Promise<CredentialKeyMutationResult>
deleteSet
Section titled “deleteSet”deleteSet: (
orgName,repoName,setName) =>Promise<CredentialDeleteResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
Returns
Section titled “Returns”Promise<CredentialDeleteResult>
grantRepo
Section titled “grantRepo”grantRepo: (
orgName,repoName,setName,targetRepoName) =>Promise<CredentialGrantResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
targetRepoName
Section titled “targetRepoName”string
Returns
Section titled “Returns”Promise<CredentialGrantResult>
ungrantRepo
Section titled “ungrantRepo”ungrantRepo: (
orgName,repoName,setName,targetRepoName) =>Promise<CredentialUngrantResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
targetRepoName
Section titled “targetRepoName”string
Returns
Section titled “Returns”Promise<CredentialUngrantResult>
listAuditLog
Section titled “listAuditLog”listAuditLog: (
orgName,repoName,setName,opts?) =>Promise<CredentialAuditEntry[]>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
limit?
Section titled “limit?”number
Returns
Section titled “Returns”Promise<CredentialAuditEntry[]>
revokeSet
Section titled “revokeSet”revokeSet: (
orgName,repoName,setName,opts?) =>Promise<CredentialRevokeResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<CredentialRevokeResult>
credentials
Section titled “credentials”
readonlycredentials:object
createSet
Section titled “createSet”createSet: (
orgName,repoName,name,opts?) =>Promise<CredentialInfo>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
scope?
Section titled “scope?”"repo" | "org"
description?
Section titled “description?”string
Returns
Section titled “Returns”Promise<CredentialInfo>
listSets
Section titled “listSets”listSets: (
orgName,repoName) =>Promise<CredentialInfo[]>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<CredentialInfo[]>
getSet
Section titled “getSet”getSet: (
orgName,repoName,name) =>Promise<CredentialInfo>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
string
Returns
Section titled “Returns”Promise<CredentialInfo>
setKey
Section titled “setKey”setKey: (
orgName,repoName,setName,keyName,value) =>Promise<CredentialKeyMutationResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
keyName
Section titled “keyName”string
string
Returns
Section titled “Returns”Promise<CredentialKeyMutationResult>
setKeys
Section titled “setKeys”setKeys: (
orgName,repoName,setName,secrets) =>Promise<CredentialKeyMutationResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
secrets
Section titled “secrets”Record<string, string>
Returns
Section titled “Returns”Promise<CredentialKeyMutationResult>
unsetKey
Section titled “unsetKey”unsetKey: (
orgName,repoName,setName,keyName) =>Promise<CredentialKeyMutationResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
keyName
Section titled “keyName”string
Returns
Section titled “Returns”Promise<CredentialKeyMutationResult>
deleteSet
Section titled “deleteSet”deleteSet: (
orgName,repoName,setName) =>Promise<CredentialDeleteResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
Returns
Section titled “Returns”Promise<CredentialDeleteResult>
grantRepo
Section titled “grantRepo”grantRepo: (
orgName,repoName,setName,targetRepoName) =>Promise<CredentialGrantResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
targetRepoName
Section titled “targetRepoName”string
Returns
Section titled “Returns”Promise<CredentialGrantResult>
ungrantRepo
Section titled “ungrantRepo”ungrantRepo: (
orgName,repoName,setName,targetRepoName) =>Promise<CredentialUngrantResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
targetRepoName
Section titled “targetRepoName”string
Returns
Section titled “Returns”Promise<CredentialUngrantResult>
listAuditLog
Section titled “listAuditLog”listAuditLog: (
orgName,repoName,setName,opts?) =>Promise<CredentialAuditEntry[]>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
limit?
Section titled “limit?”number
Returns
Section titled “Returns”Promise<CredentialAuditEntry[]>
revokeSet
Section titled “revokeSet”revokeSet: (
orgName,repoName,setName,opts?) =>Promise<CredentialRevokeResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
setName
Section titled “setName”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<CredentialRevokeResult>
actions
Section titled “actions”
readonlyactions:object
acquireLease
Section titled “acquireLease”acquireLease: (
orgName,repoName,subscriptionName,holderId,holderType,opts?) =>Promise<ActionLeaseAcquire>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
holderId
Section titled “holderId”string
holderType
Section titled “holderType”"sdk" | "sprite" | "cli"
graceMs?
Section titled “graceMs?”number
ttlMs?
Section titled “ttlMs?”number
Returns
Section titled “Returns”Promise<ActionLeaseAcquire>
heartbeatLease
Section titled “heartbeatLease”heartbeatLease: (
orgName,repoName,subscriptionName,holderId,ttlMs?) =>Promise<ActionLeaseOp>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
holderId
Section titled “holderId”string
ttlMs?
Section titled “ttlMs?”number
Returns
Section titled “Returns”Promise<ActionLeaseOp>
releaseLease
Section titled “releaseLease”releaseLease: (
orgName,repoName,subscriptionName,holderId) =>Promise<ActionLeaseOp>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
holderId
Section titled “holderId”string
Returns
Section titled “Returns”Promise<ActionLeaseOp>
claimDelivery
Section titled “claimDelivery”claimDelivery: (
orgName,repoName,subscriptionName,commitId,holderId) =>Promise<ActionLeaseOp>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
commitId
Section titled “commitId”string
holderId
Section titled “holderId”string
Returns
Section titled “Returns”Promise<ActionLeaseOp>
completeDelivery
Section titled “completeDelivery”completeDelivery: (
orgName,repoName,subscriptionName,commitId,holderId) =>Promise<ActionLeaseOp>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
commitId
Section titled “commitId”string
holderId
Section titled “holderId”string
Returns
Section titled “Returns”Promise<ActionLeaseOp>
liveFeed
Section titled “liveFeed”liveFeed: (
orgName,repoName,subscriptionName,opts?) =>Promise<ActionLiveFeedResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
Returns
Section titled “Returns”Promise<ActionLiveFeedResult>
listRuns
Section titled “listRuns”listRuns: (
orgName,repoName,opts?) =>Promise<ActionRun[]>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
Returns
Section titled “Returns”Promise<ActionRun[]>
getRunAttempts
Section titled “getRunAttempts”getRunAttempts: (
orgName,repoName,subscriptionName,commitId) =>Promise<ActionAttempt[]>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
subscriptionName
Section titled “subscriptionName”string
commitId
Section titled “commitId”string
Returns
Section titled “Returns”Promise<ActionAttempt[]>
listNotifications
Section titled “listNotifications”listNotifications: (
orgName,repoName,opts?) =>Promise<ActionNotification[]>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
ActionListNotificationsOptions
Returns
Section titled “Returns”Promise<ActionNotification[]>
changeset
Section titled “changeset”
readonlychangeset:object
publish
Section titled “publish”publish: (
orgName,repoName,workspaceName,message,rationale?,opts?) =>Promise<ChangesetRef>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
workspaceName
Section titled “workspaceName”string
message
Section titled “message”string
rationale?
Section titled “rationale?”string
squash?
Section titled “squash?”boolean
Returns
Section titled “Returns”Promise<ChangesetRef>
list: (
orgName,repoName,opts?) =>Promise<Page<ChangesetDetail>>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
status?
Section titled “status?”string
limit?
Section titled “limit?”number
Returns
Section titled “Returns”Promise<Page<ChangesetDetail>>
get: (
orgName,repoName,changesetNumber) =>Promise<ChangesetDetail>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
changesetNumber
Section titled “changesetNumber”number
Returns
Section titled “Returns”Promise<ChangesetDetail>
accept
Section titled “accept”accept: (
orgName,repoName,changesetNumber) =>Promise<ChangesetAcceptResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
changesetNumber
Section titled “changesetNumber”number
Returns
Section titled “Returns”Promise<ChangesetAcceptResult>
reject
Section titled “reject”reject: (
orgName,repoName,changesetNumber,reason?) =>Promise<ChangesetAcceptResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
changesetNumber
Section titled “changesetNumber”number
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<ChangesetAcceptResult>
withdraw
Section titled “withdraw”withdraw: (
orgName,repoName,changesetNumber) =>Promise<ChangesetAcceptResult>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
changesetNumber
Section titled “changesetNumber”number
Returns
Section titled “Returns”Promise<ChangesetAcceptResult>
validate
Section titled “validate”validate: (
orgName,repoName,changesetNumber) =>Promise<ChangesetValidation>
Parameters
Section titled “Parameters”orgName
Section titled “orgName”string
repoName
Section titled “repoName”string
changesetNumber
Section titled “changesetNumber”number
Returns
Section titled “Returns”Promise<ChangesetValidation>
Methods
Section titled “Methods”withAccessToken()
Section titled “withAccessToken()”withAccessToken(
accessToken):WarmHubClient
Parameters
Section titled “Parameters”accessToken
Section titled “accessToken”Returns
Section titled “Returns”WarmHubClient