@nestbox-ai/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @nestbox-ai/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AuthApi | authControllerExchangeToken | POST /auth/google/{token} | Exchange token AuthApi | authControllerForgetPassword | POST /auth/forget-password | Forget password initiate AuthApi | authControllerForgetPasswordVerification | POST /auth/forget-password/verification | Forget password verification AuthApi | authControllerLogin | POST /auth/login | Login to the application AuthApi | authControllerOAuthLogin | POST /auth/login/oauth | Login with OAuth apps AuthApi | authControllerResetPassword | POST /auth/reset-password | Forget password initiate AuthApi | authControllerSignup | POST /auth/signup | Signup in the application DocumentsApi | documentControllerAddDocToCollection | POST /projects/{projectId}/document/{instanceId}/collections/{collectionId}/docs | Add a new doc DocumentsApi | documentControllerAddDocToCollectionFromFile | POST /projects/{projectId}/document/{instanceId}/collections/{collectionId}/docs/file | Use a file to chunk and add to collection DocumentsApi | documentControllerCreateCollection | POST /projects/{projectId}/document/{instanceId}/collections | Create collection DocumentsApi | documentControllerDeleteCollection | DELETE /projects/{projectId}/document/{instanceId}/collections/{collectionId} | Delete collection DocumentsApi | documentControllerDeleteDocById | DELETE /projects/{projectId}/document/{instanceId}/collections/{collectionId}/docs/{docId} | Delete doc by ID DocumentsApi | documentControllerDeleteDocsFromCollection | DELETE /projects/{projectId}/document/{instanceId}/collections/{collectionId}/docs | Delete docs based on metadata filters DocumentsApi | documentControllerGetAllCollections | GET /projects/{projectId}/document/{instanceId}/collections | Get all collections DocumentsApi | documentControllerGetCollectionInfo | GET /projects/{projectId}/document/{instanceId}/collections/{collectionId} | Get collection info DocumentsApi | documentControllerGetDocById | GET /projects/{projectId}/document/{instanceId}/collections/{collectionId}/docs/{docId} | Get doc by ID DocumentsApi | documentControllerSimilaritySearch | POST /projects/{projectId}/document/{instanceId}/collections/{collectionId}/query | Similarity search query DocumentsApi | documentControllerUpdateCollection | PUT /projects/{projectId}/document/{instanceId}/collections/{collectionId} | Update collection DocumentsApi | documentControllerUpdateDoc | PUT /projects/{projectId}/document/{instanceId}/collections/{collectionId}/docs/{docId} | Update or upsert doc EvaluationTestApi | evaluationTestControllerAddEvaluationTest | POST /projects/{projectId}/evaluation-tests | Add new evaluation test. EvaluationTestApi | evaluationTestControllerDeleteEvaluation | DELETE /projects/{projectId}/evaluation-tests/{testId} | Delete evaluation EvaluationTestApi | evaluationTestControllerExecuteEvaluation | PUT /projects/{projectId}/evaluation-tests/{testId}/execute | Execute evaluation test. EvaluationTestApi | evaluationTestControllerGetEvaluationTest | GET /projects/{projectId}/evaluation-tests/{modelId} | Fetch evaluation test. EvaluationTestApi | evaluationTestControllerUpdateEvaluation | PUT /projects/{projectId}/evaluation-tests/{testId} | Update evaluation test MachineAgentApi | machineAgentControllerCreateMachineAgent | POST /projects/{projectId}/agents | Create New Machine Agent MachineAgentApi | machineAgentControllerDeleteMachineAgents | DELETE /projects/{projectId}/agents/{agentId} | Delete machine agent MachineAgentApi | machineAgentControllerGetMachineAgentByProjectId | GET /projects/{projectId}/agents | Get all machine agent with count MachineAgentApi | machineAgentControllerUpdateMachineAgent | PATCH /projects/{projectId}/agents/{agentId} | Update machine agent by id MachineAgentLogsApi | logsControllerFetchAgentLogs | GET /projects/{projectId}/logs/{agentId} | Fetch agent logs. MachineAgentLogsApi | logsControllerFetchEventLogs | GET /projects/{projectId}/fetchEventLogs/{agentId} | Fetch event logs. MachineInstancesApi | machineInstancesControllerCreateMachineInstance | POST /projects/{projectId}/instances | Create Machine Instance MachineInstancesApi | machineInstancesControllerDeleteMachineInstance | DELETE /projects/{projectId}/instances | Delete machine instances by ids MachineInstancesApi | machineInstancesControllerGetInstanceRunningStatus | GET /projects/{projectId}/instances/status | Retrieve running status of instances MachineInstancesApi | machineInstancesControllerGetMachineBenchmarkingDatapoints | GET /projects/{projectId}/instances/machine/{machineId}/benchmarking-datapoints | Retrieve CSV benchmarking datapoints for a specific machine MachineInstancesApi | machineInstancesControllerGetMachineBenchmarkingReports | GET /projects/{projectId}/instances/machine/{machineId}/benchmarking-reports | Retrieve benchmarking reports for a specific machine MachineInstancesApi | machineInstancesControllerGetMachineBootstrapStatus | GET /projects/{projectId}/instances/machine/{machineId}/status | Retrieve status of a specific machine instance MachineInstancesApi | machineInstancesControllerGetMachineInstanceById | GET /projects/{projectId}/instances/machine/{machineId} | Retrieve running status of instances MachineInstancesApi | machineInstancesControllerGetMachineInstanceByUserId | GET /projects/{projectId}/instances | Retrieve all machine instances with count MachineInstancesApi | machineInstancesControllerUpdateRunningStatus | PUT /projects/{projectId}/instances/status | Update Machine Instance Running Status MembersApi | membersControllerAddTeamMemberToProject | POST /projects/{projectId}/members | Add a team member MembersApi | membersControllerGetAllTeamMembersOfProject | GET /projects/{projectId}/members | Retrieve all team members MembersApi | membersControllerUpdateTeamMemberRole | PATCH /projects/{projectId}/members/{memberId} | Update team member details MiscellaneousApi | miscellaneousControllerGetData | GET /projects/machine/images | Get machine id matching instances. MiscellaneousApi | miscellaneousControllerGetMachineInstanceByImageId | GET /projects/{projectId}/allMachineInstance | Get machine id matching instances. MiscellaneousApi | miscellaneousControllerUpdateTeamMemberStatus | PATCH /projects/member/join | Join project NotificationsApi | notificationsControllerGetLastFiveNotifications | GET /projects/{projectId}/notifications | Retrieve last notifications NotificationsApi | notificationsControllerMarkNotificationsAsRead | PUT /projects/{projectId}/notifications/status | Mark notification as read ProjectsApi | projectControllerCreateProject | POST /projects | Create Project ProjectsApi | projectControllerDeleteProjectById | DELETE /projects/{id} | Delete project by id ProjectsApi | projectControllerGetAllProjects | GET /projects | Get all projects ProjectsApi | projectControllerGetProjectById | GET /projects/{id} | Get project by id ProjectsApi | projectControllerUpdateProjectById | PATCH /projects/{id} | Update project by id QueriesAndDocumentationsApi | queriesAndDocControllerFetchSwaggerJSON | GET /projects/{projectId}/{fieldName}/{modelId}/swagger | Fetch Swagger JSON QueriesAndDocumentationsApi | queriesAndDocControllerRunQuery | POST /projects/{projectId}/queries | Run Query RolesApi | rolesControllerCreateProjectRole | POST /projects/{projectId}/roles | Create a new role RolesApi | rolesControllerDeleteProjectRole | DELETE /projects/{projectId}/roles/{roleId} | Delete Project Role RolesApi | rolesControllerGetAllProjectRoles | GET /projects/{projectId}/roles | Retrieve all roles RolesApi | rolesControllerGetProjectRoleById | GET /projects/{projectId}/roles/{roleId} | Retrieve a role by ID RolesApi | rolesControllerGetUserProjectRole | GET /projects/{id}/members/role | Retrieve the role of a specific member RolesApi | rolesControllerUpdateProjectRoleById | PATCH /projects/{projectId}/roles/{roleId} | Update a role WebhookApi | webhookControllerCreateWebhook | POST /projects/{projectId}/webhooks | Create webhook WebhookApi | webhookControllerDeleteWebhook | DELETE /projects/{projectId}/webhooks/{modelId} | Delete webhook WebhookApi | webhookControllerFetchWebhook | GET /projects/{projectId}/webhooks/{modelId} | Fetch webhook WebhookApi | webhookControllerUpdateWebhook | PUT /projects/{projectId}/webhooks/{webhookId} | Update webhook

Documentation For Models

• AddProjectMemberData
• AddProjectMemberDto
• AddProjectMemberResponseDTO
• AllProjectResponse
• AllProjectResponseModel
• BadRequestExceptionResponse
• BenchmarkingDatapointDto
• BenchmarkingReportsDto
• BooleanResponseDTO
• ChunkFileRequestDTO
• CreateCollectionRequestDTO
• CreateDocumentRequestDTO
• CreateMachineAgentDto
• CreatePermissionDto
• CreateProjectDTO
• CreateProjectResponseDTO
• CreateProjectRoleResponseDto
• CreateResourceDto
• CreateRoleDTO
• CreateRoleDto
• CreateWebhookDto
• DeleteProjectDto
• DeleteProjectResponseDTO
• DeleteProjectRoleByIdResponseDto
• FatalErrorExceptionResponse
• ForbiddenExceptionResponse
• ForgetPasswordRequestDTO
• ForgetPasswordResponseDTO
• ForgetPasswordVerificationRequestDTO
• ForgetPasswordVerificationResponseDTO
• GetAllProjectDto
• GetAllProjectMemberResponse
• GetAllProjectMemberResponseDto
• GetAllProjectRoleResponseDto
• GetAllProjectsResponseDTO
• GetAllRoleDTO
• GetProjectByIDResponseDTO
• GetProjectRoleByIdResponseDto
• GetRoleDTO
• GetUserProjectRoleByRoleIdResponseDto
• LoginRequestDTO
• LoginResponseDTO
• MachineStatusDto
• MessageResponseDTO
• NotFoundExceptionResponse
• OAuthLoginRequestDTO
• PermissionsDTO
• ProjectResponseModel
• ResetPasswordRequestDTO
• ResourceDTO
• RoleDto
• SignupRequestDTO
• SignupResponseDTO
• SimilaritySearchQueryDTO
• TeamMemberDto
• UnauthorizedExceptionResponse
• UpdateDocumentRequestDTO
• UpdatePermissionDto
• UpdateProjectByIDResponseDTO
• UpdateProjectByIdRequest
• UpdateProjectRoleResponseDto
• UpdateResourceDto
• UpdateRoleByIdDto
• UpdateRoleDTO
• UpdateTeamMemberRequestDTO
• UpdateTeamMemberStatusRequestDTO
• UserDto

Documentation For Authorization

Endpoints do not require authorization.