api.md

Shared

Types:

• BasicVal
• ExtendedVal
• PaginationLinks
• ResultSet
• User

Search

Vals

Methods:

• client.search.vals.list({ ...params }) -> BasicValsPageCursorURL

Alias

Username

Methods:

• client.alias.username.retrieve(username) -> User

ValName

Types:

• ValNameRetrieveResponse

Methods:

• client.alias.username.valName.retrieve(username, valName) -> ValNameRetrieveResponse

ProjectName

Types:

• ProjectNameRetrieveResponse

Methods:

• client.alias.username.projectName.retrieve(username, projectName) -> ProjectNameRetrieveResponse

Me

Profile

Types:

• ProfileRetrieveResponse

Methods:

• client.me.profile.retrieve() -> ProfileRetrieveResponse

Likes

Methods:

• client.me.likes.list({ ...params }) -> BasicValsPageCursorURL

Comments

Types:

• CommentListResponse

Methods:

• client.me.comments.list({ ...params }) -> CommentListResponsesPageCursorURL

References

Types:

• ReferenceListResponse

Methods:

• client.me.references.list({ ...params }) -> ReferenceListResponsesPageCursorURL

Projects

Types:

• ProjectListResponse

Methods:

• client.me.projects.list({ ...params }) -> ProjectListResponsesPageCursorURL

Blobs

Types:

• BlobListResponse

Methods:

• client.blobs.list({ ...params }) -> BlobListResponse
• client.blobs.delete(key) -> void
• client.blobs.get(key) -> Response
• client.blobs.store(key, { ...params }) -> void

Users

Methods:

• client.users.retrieve(userId) -> User

Vals

Methods:

• client.users.vals.list(userId, { ...params }) -> BasicValsPageCursorURL

Sqlite

Types:

• SqliteBatchResponse

Methods:

• client.sqlite.batch({ ...params }) -> SqliteBatchResponse
• client.sqlite.execute({ ...params }) -> ResultSet

Vals

Types:

• ValCancelEvaluationResponse

Methods:

• client.vals.create({ ...params }) -> ExtendedVal
• client.vals.retrieve(valId) -> ExtendedVal
• client.vals.update(valId, { ...params }) -> void
• client.vals.delete(valId) -> void
• client.vals.cancelEvaluation(valId, evaluationId) -> ValCancelEvaluationResponse
• client.vals.createOrUpdate({ ...params }) -> void

Versions

Types:

• VersionListResponse

Methods:

• client.vals.versions.create(valId, { ...params }) -> ExtendedVal
• client.vals.versions.retrieve(valId, version, { ...params }) -> ExtendedVal
• client.vals.versions.list(valId, { ...params }) -> VersionListResponsesPageCursorURL
• client.vals.versions.delete(valId, version) -> void

Emails

Types:

• EmailSendResponse

Methods:

• client.emails.send({ ...params }) -> EmailSendResponse

Projects

Types:

• ProjectCreateResponse
• ProjectRetrieveResponse
• ProjectListResponse

Methods:

• client.projects.create({ ...params }) -> ProjectCreateResponse
• client.projects.retrieve(projectId) -> ProjectRetrieveResponse
• client.projects.list({ ...params }) -> ProjectListResponsesPageCursorURL

Branches

Types:

• BranchCreateResponse
• BranchRetrieveResponse
• BranchListResponse

Methods:

• client.projects.branches.create(projectId, { ...params }) -> BranchCreateResponse
• client.projects.branches.retrieve(projectId, branchId) -> BranchRetrieveResponse
• client.projects.branches.list(projectId, { ...params }) -> BranchListResponsesPageCursorURL

Files

Types:

• FileCreateResponse
• FileRetrieveResponse
• FileListResponse

Methods:

• client.projects.files.create(projectId, path, { ...params }) -> FileCreateResponse
• client.projects.files.retrieve(projectId, path, { ...params }) -> FileRetrieveResponse
• client.projects.files.list(projectId, { ...params }) -> FileListResponsesPageCursorURL
• client.projects.files.content(projectId, path, { ...params }) -> Response