@nestbox-ai/admin 1.0.39 → 1.0.42

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/.openapi-generator/FILES +77 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +144 -2
  4. package/api.ts +207 -460
  5. package/dist/api.d.ts +110 -227
  6. package/dist/api.js +194 -440
  7. package/dist/esm/api.d.ts +110 -227
  8. package/dist/esm/api.js +189 -435
  9. package/docs/AddProjectMemberData.md +22 -0
  10. package/docs/AddProjectMemberDto.md +26 -0
  11. package/docs/AddProjectMemberResponseDTO.md +20 -0
  12. package/docs/AllProjectResponse.md +30 -0
  13. package/docs/AllProjectResponseModel.md +22 -0
  14. package/docs/AuthApi.md +405 -0
  15. package/docs/BadRequestExceptionResponse.md +22 -0
  16. package/docs/BooleanResponseDTO.md +20 -0
  17. package/docs/ChunkFileRequestDTO.md +24 -0
  18. package/docs/CreateCollectionRequestDTO.md +22 -0
  19. package/docs/CreateDocumentRequestDTO.md +24 -0
  20. package/docs/CreateMachineAgentDto.md +42 -0
  21. package/docs/CreatePermissionDto.md +26 -0
  22. package/docs/CreateProjectDTO.md +22 -0
  23. package/docs/CreateProjectResponseDTO.md +20 -0
  24. package/docs/CreateProjectRoleResponseDto.md +20 -0
  25. package/docs/CreateResourceDto.md +22 -0
  26. package/docs/CreateRoleDTO.md +26 -0
  27. package/docs/CreateRoleDto.md +24 -0
  28. package/docs/CreateWebhookDto.md +22 -0
  29. package/docs/DeleteProjectDto.md +20 -0
  30. package/docs/DeleteProjectResponseDTO.md +20 -0
  31. package/docs/DeleteProjectRoleByIdResponseDto.md +20 -0
  32. package/docs/DocumentsApi.md +781 -0
  33. package/docs/EvaluationTestApi.md +299 -0
  34. package/docs/FatalErrorExceptionResponse.md +20 -0
  35. package/docs/ForbiddenExceptionResponse.md +20 -0
  36. package/docs/ForgetPasswordRequestDTO.md +20 -0
  37. package/docs/ForgetPasswordResponseDTO.md +20 -0
  38. package/docs/ForgetPasswordVerificationRequestDTO.md +20 -0
  39. package/docs/ForgetPasswordVerificationResponseDTO.md +20 -0
  40. package/docs/GetAllProjectDto.md +22 -0
  41. package/docs/GetAllProjectMemberResponse.md +22 -0
  42. package/docs/GetAllProjectMemberResponseDto.md +20 -0
  43. package/docs/GetAllProjectRoleResponseDto.md +20 -0
  44. package/docs/GetAllProjectsResponseDTO.md +20 -0
  45. package/docs/GetAllRoleDTO.md +32 -0
  46. package/docs/GetProjectByIDResponseDTO.md +20 -0
  47. package/docs/GetProjectRoleByIdResponseDto.md +20 -0
  48. package/docs/GetRoleDTO.md +26 -0
  49. package/docs/GetUserProjectRoleByRoleIdResponseDto.md +20 -0
  50. package/docs/LoginRequestDTO.md +22 -0
  51. package/docs/LoginResponseDTO.md +20 -0
  52. package/docs/MachineAgentApi.md +253 -0
  53. package/docs/MachineAgentLogsApi.md +66 -0
  54. package/docs/MachineInstancesApi.md +361 -0
  55. package/docs/MembersApi.md +204 -0
  56. package/docs/MessageResponseDTO.md +20 -0
  57. package/docs/MiscellaneousApi.md +169 -0
  58. package/docs/NotFoundExceptionResponse.md +20 -0
  59. package/docs/NotificationsApi.md +122 -0
  60. package/docs/OAuthLoginRequestDTO.md +26 -0
  61. package/docs/PermissionsDTO.md +28 -0
  62. package/docs/ProjectResponseModel.md +30 -0
  63. package/docs/ProjectsApi.md +301 -0
  64. package/docs/QueriesAndDocumentationsApi.md +125 -0
  65. package/docs/ResetPasswordRequestDTO.md +22 -0
  66. package/docs/ResourceDTO.md +24 -0
  67. package/docs/RoleDto.md +22 -0
  68. package/docs/RolesApi.md +372 -0
  69. package/docs/SignupRequestDTO.md +36 -0
  70. package/docs/SignupResponseDTO.md +20 -0
  71. package/docs/SimilaritySearchQueryDTO.md +26 -0
  72. package/docs/TeamMemberDto.md +26 -0
  73. package/docs/UnauthorizedExceptionResponse.md +20 -0
  74. package/docs/UpdateDocumentRequestDTO.md +22 -0
  75. package/docs/UpdatePermissionDto.md +28 -0
  76. package/docs/UpdateProjectByIDResponseDTO.md +20 -0
  77. package/docs/UpdateProjectByIdRequest.md +22 -0
  78. package/docs/UpdateProjectRoleResponseDto.md +20 -0
  79. package/docs/UpdateResourceDto.md +24 -0
  80. package/docs/UpdateRoleByIdDto.md +24 -0
  81. package/docs/UpdateRoleDTO.md +26 -0
  82. package/docs/UpdateTeamMemberRequestDTO.md +20 -0
  83. package/docs/UpdateTeamMemberStatusRequestDTO.md +22 -0
  84. package/docs/UserDto.md +32 -0
  85. package/docs/WebhookApi.md +243 -0
  86. package/package.json +1 -1
@@ -0,0 +1,20 @@
1
+ # UpdateTeamMemberRequestDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **roleId** | **number** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { UpdateTeamMemberRequestDTO } from '@nestbox-ai/admin';
14
+
15
+ const instance: UpdateTeamMemberRequestDTO = {
16
+ roleId,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # UpdateTeamMemberStatusRequestDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **status** | **string** | | [default to undefined]
9
+ **token** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { UpdateTeamMemberStatusRequestDTO } from '@nestbox-ai/admin';
15
+
16
+ const instance: UpdateTeamMemberStatusRequestDTO = {
17
+ status,
18
+ token,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,32 @@
1
+ # UserDto
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **number** | | [default to undefined]
9
+ **firstName** | **string** | | [default to undefined]
10
+ **lastName** | **string** | | [default to undefined]
11
+ **email** | **string** | | [default to undefined]
12
+ **status** | **string** | | [default to undefined]
13
+ **profilePicture** | **string** | | [default to undefined]
14
+ **bio** | **string** | | [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { UserDto } from '@nestbox-ai/admin';
20
+
21
+ const instance: UserDto = {
22
+ id,
23
+ firstName,
24
+ lastName,
25
+ email,
26
+ status,
27
+ profilePicture,
28
+ bio,
29
+ };
30
+ ```
31
+
32
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,243 @@
1
+ # WebhookApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**webhookControllerCreateWebhook**](#webhookcontrollercreatewebhook) | **POST** /projects/{projectId}/webhooks | Create webhook|
8
+ |[**webhookControllerDeleteWebhook**](#webhookcontrollerdeletewebhook) | **DELETE** /projects/{projectId}/webhooks/{modelId} | Delete webhook|
9
+ |[**webhookControllerFetchWebhook**](#webhookcontrollerfetchwebhook) | **GET** /projects/{projectId}/webhooks/{modelId} | Fetch webhook|
10
+ |[**webhookControllerUpdateWebhook**](#webhookcontrollerupdatewebhook) | **PUT** /projects/{projectId}/webhooks/{webhookId} | Update webhook|
11
+
12
+ # **webhookControllerCreateWebhook**
13
+ > CreateWebhookDto webhookControllerCreateWebhook()
14
+
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ WebhookApi,
21
+ Configuration
22
+ } from '@nestbox-ai/admin';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new WebhookApi(configuration);
26
+
27
+ let projectId: string; // (default to undefined)
28
+
29
+ const { status, data } = await apiInstance.webhookControllerCreateWebhook(
30
+ projectId
31
+ );
32
+ ```
33
+
34
+ ### Parameters
35
+
36
+ |Name | Type | Description | Notes|
37
+ |------------- | ------------- | ------------- | -------------|
38
+ | **projectId** | [**string**] | | defaults to undefined|
39
+
40
+
41
+ ### Return type
42
+
43
+ **CreateWebhookDto**
44
+
45
+ ### Authorization
46
+
47
+ No authorization required
48
+
49
+ ### HTTP request headers
50
+
51
+ - **Content-Type**: Not defined
52
+ - **Accept**: application/json
53
+
54
+
55
+ ### HTTP response details
56
+ | Status code | Description | Response headers |
57
+ |-------------|-------------|------------------|
58
+ |**200** | | - |
59
+ |**400** | | - |
60
+ |**401** | | - |
61
+ |**403** | | - |
62
+ |**404** | | - |
63
+ |**500** | | - |
64
+
65
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
66
+
67
+ # **webhookControllerDeleteWebhook**
68
+ > CreateWebhookDto webhookControllerDeleteWebhook()
69
+
70
+
71
+ ### Example
72
+
73
+ ```typescript
74
+ import {
75
+ WebhookApi,
76
+ Configuration
77
+ } from '@nestbox-ai/admin';
78
+
79
+ const configuration = new Configuration();
80
+ const apiInstance = new WebhookApi(configuration);
81
+
82
+ let projectId: string; // (default to undefined)
83
+ let modelId: string; // (default to undefined)
84
+
85
+ const { status, data } = await apiInstance.webhookControllerDeleteWebhook(
86
+ projectId,
87
+ modelId
88
+ );
89
+ ```
90
+
91
+ ### Parameters
92
+
93
+ |Name | Type | Description | Notes|
94
+ |------------- | ------------- | ------------- | -------------|
95
+ | **projectId** | [**string**] | | defaults to undefined|
96
+ | **modelId** | [**string**] | | defaults to undefined|
97
+
98
+
99
+ ### Return type
100
+
101
+ **CreateWebhookDto**
102
+
103
+ ### Authorization
104
+
105
+ No authorization required
106
+
107
+ ### HTTP request headers
108
+
109
+ - **Content-Type**: Not defined
110
+ - **Accept**: application/json
111
+
112
+
113
+ ### HTTP response details
114
+ | Status code | Description | Response headers |
115
+ |-------------|-------------|------------------|
116
+ |**200** | | - |
117
+ |**400** | | - |
118
+ |**401** | | - |
119
+ |**403** | | - |
120
+ |**404** | | - |
121
+ |**500** | | - |
122
+
123
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
124
+
125
+ # **webhookControllerFetchWebhook**
126
+ > CreateWebhookDto webhookControllerFetchWebhook()
127
+
128
+
129
+ ### Example
130
+
131
+ ```typescript
132
+ import {
133
+ WebhookApi,
134
+ Configuration
135
+ } from '@nestbox-ai/admin';
136
+
137
+ const configuration = new Configuration();
138
+ const apiInstance = new WebhookApi(configuration);
139
+
140
+ let projectId: string; // (default to undefined)
141
+ let modelId: string; // (default to undefined)
142
+ let isAgentWebhook: boolean; // (default to undefined)
143
+
144
+ const { status, data } = await apiInstance.webhookControllerFetchWebhook(
145
+ projectId,
146
+ modelId,
147
+ isAgentWebhook
148
+ );
149
+ ```
150
+
151
+ ### Parameters
152
+
153
+ |Name | Type | Description | Notes|
154
+ |------------- | ------------- | ------------- | -------------|
155
+ | **projectId** | [**string**] | | defaults to undefined|
156
+ | **modelId** | [**string**] | | defaults to undefined|
157
+ | **isAgentWebhook** | [**boolean**] | | defaults to undefined|
158
+
159
+
160
+ ### Return type
161
+
162
+ **CreateWebhookDto**
163
+
164
+ ### Authorization
165
+
166
+ No authorization required
167
+
168
+ ### HTTP request headers
169
+
170
+ - **Content-Type**: Not defined
171
+ - **Accept**: application/json
172
+
173
+
174
+ ### HTTP response details
175
+ | Status code | Description | Response headers |
176
+ |-------------|-------------|------------------|
177
+ |**200** | | - |
178
+ |**400** | | - |
179
+ |**401** | | - |
180
+ |**403** | | - |
181
+ |**404** | | - |
182
+ |**500** | | - |
183
+
184
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
185
+
186
+ # **webhookControllerUpdateWebhook**
187
+ > CreateWebhookDto webhookControllerUpdateWebhook()
188
+
189
+
190
+ ### Example
191
+
192
+ ```typescript
193
+ import {
194
+ WebhookApi,
195
+ Configuration
196
+ } from '@nestbox-ai/admin';
197
+
198
+ const configuration = new Configuration();
199
+ const apiInstance = new WebhookApi(configuration);
200
+
201
+ let webhookId: string; // (default to undefined)
202
+ let projectId: string; // (default to undefined)
203
+
204
+ const { status, data } = await apiInstance.webhookControllerUpdateWebhook(
205
+ webhookId,
206
+ projectId
207
+ );
208
+ ```
209
+
210
+ ### Parameters
211
+
212
+ |Name | Type | Description | Notes|
213
+ |------------- | ------------- | ------------- | -------------|
214
+ | **webhookId** | [**string**] | | defaults to undefined|
215
+ | **projectId** | [**string**] | | defaults to undefined|
216
+
217
+
218
+ ### Return type
219
+
220
+ **CreateWebhookDto**
221
+
222
+ ### Authorization
223
+
224
+ No authorization required
225
+
226
+ ### HTTP request headers
227
+
228
+ - **Content-Type**: Not defined
229
+ - **Accept**: application/json
230
+
231
+
232
+ ### HTTP response details
233
+ | Status code | Description | Response headers |
234
+ |-------------|-------------|------------------|
235
+ |**200** | | - |
236
+ |**400** | | - |
237
+ |**401** | | - |
238
+ |**403** | | - |
239
+ |**404** | | - |
240
+ |**500** | | - |
241
+
242
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
243
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nestbox-ai/admin",
3
- "version": "1.0.39",
3
+ "version": "1.0.42",
4
4
  "description": "OpenAPI client for @nestbox-ai/admin",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {