@nestbox-ai/doc-processing-api 1.0.61 → 1.0.63
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.
- package/.openapi-generator/FILES +5 -0
- package/README.md +11 -2
- package/api.ts +431 -0
- package/dist/api.d.ts +228 -0
- package/dist/api.js +379 -1
- package/dist/esm/api.d.ts +228 -0
- package/dist/esm/api.js +375 -1
- package/docs/CreateWebhookInputDto.md +20 -0
- package/docs/PaginatedWebhooksDto.md +22 -0
- package/docs/UpdateWebhookBodyInputDto.md +20 -0
- package/docs/WebhookDto.md +26 -0
- package/docs/WebhooksApi.md +280 -0
- package/package.json +1 -1
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PaginatedWebhooksDto
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**Array<WebhookDto>**](WebhookDto.md) | Webhook data | [default to undefined]
|
|
9
|
+
**pagination** | [**PaginationDto**](PaginationDto.md) | Pagination information | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PaginatedWebhooksDto } from '@nestbox-ai/doc-processing-api';
|
|
15
|
+
|
|
16
|
+
const instance: PaginatedWebhooksDto = {
|
|
17
|
+
data,
|
|
18
|
+
pagination,
|
|
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,20 @@
|
|
|
1
|
+
# UpdateWebhookBodyInputDto
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**url** | **string** | Updated webhook target URL | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdateWebhookBodyInputDto } from '@nestbox-ai/doc-processing-api';
|
|
14
|
+
|
|
15
|
+
const instance: UpdateWebhookBodyInputDto = {
|
|
16
|
+
url,
|
|
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,26 @@
|
|
|
1
|
+
# WebhookDto
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Webhook ID | [default to undefined]
|
|
9
|
+
**url** | **string** | Webhook target URL | [default to undefined]
|
|
10
|
+
**createdAt** | **string** | Webhook creation timestamp | [default to undefined]
|
|
11
|
+
**updatedAt** | **string** | Webhook last update timestamp | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { WebhookDto } from '@nestbox-ai/doc-processing-api';
|
|
17
|
+
|
|
18
|
+
const instance: WebhookDto = {
|
|
19
|
+
id,
|
|
20
|
+
url,
|
|
21
|
+
createdAt,
|
|
22
|
+
updatedAt,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[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,280 @@
|
|
|
1
|
+
# WebhooksApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**webhooksControllerCreateWebhook**](#webhookscontrollercreatewebhook) | **POST** /webhooks | Create webhook|
|
|
8
|
+
|[**webhooksControllerDeleteWebhook**](#webhookscontrollerdeletewebhook) | **DELETE** /webhooks/{webhookId} | Delete webhook|
|
|
9
|
+
|[**webhooksControllerGetWebhook**](#webhookscontrollergetwebhook) | **GET** /webhooks/{webhookId} | Read webhook|
|
|
10
|
+
|[**webhooksControllerListWebhooks**](#webhookscontrollerlistwebhooks) | **GET** /webhooks | List webhooks|
|
|
11
|
+
|[**webhooksControllerUpdateWebhook**](#webhookscontrollerupdatewebhook) | **PATCH** /webhooks/{webhookId} | Update webhook|
|
|
12
|
+
|
|
13
|
+
# **webhooksControllerCreateWebhook**
|
|
14
|
+
> WebhookDto webhooksControllerCreateWebhook(createWebhookInputDto)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
WebhooksApi,
|
|
22
|
+
Configuration,
|
|
23
|
+
CreateWebhookInputDto
|
|
24
|
+
} from '@nestbox-ai/doc-processing-api';
|
|
25
|
+
|
|
26
|
+
const configuration = new Configuration();
|
|
27
|
+
const apiInstance = new WebhooksApi(configuration);
|
|
28
|
+
|
|
29
|
+
let createWebhookInputDto: CreateWebhookInputDto; //
|
|
30
|
+
|
|
31
|
+
const { status, data } = await apiInstance.webhooksControllerCreateWebhook(
|
|
32
|
+
createWebhookInputDto
|
|
33
|
+
);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
|Name | Type | Description | Notes|
|
|
39
|
+
|------------- | ------------- | ------------- | -------------|
|
|
40
|
+
| **createWebhookInputDto** | **CreateWebhookInputDto**| | |
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
### Return type
|
|
44
|
+
|
|
45
|
+
**WebhookDto**
|
|
46
|
+
|
|
47
|
+
### Authorization
|
|
48
|
+
|
|
49
|
+
No authorization required
|
|
50
|
+
|
|
51
|
+
### HTTP request headers
|
|
52
|
+
|
|
53
|
+
- **Content-Type**: application/json
|
|
54
|
+
- **Accept**: application/json
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### HTTP response details
|
|
58
|
+
| Status code | Description | Response headers |
|
|
59
|
+
|-------------|-------------|------------------|
|
|
60
|
+
|**201** | Webhook created | - |
|
|
61
|
+
|**400** | Bad request | - |
|
|
62
|
+
|**401** | Unauthorized | - |
|
|
63
|
+
|
|
64
|
+
[[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)
|
|
65
|
+
|
|
66
|
+
# **webhooksControllerDeleteWebhook**
|
|
67
|
+
> WebhookDto webhooksControllerDeleteWebhook()
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### Example
|
|
71
|
+
|
|
72
|
+
```typescript
|
|
73
|
+
import {
|
|
74
|
+
WebhooksApi,
|
|
75
|
+
Configuration
|
|
76
|
+
} from '@nestbox-ai/doc-processing-api';
|
|
77
|
+
|
|
78
|
+
const configuration = new Configuration();
|
|
79
|
+
const apiInstance = new WebhooksApi(configuration);
|
|
80
|
+
|
|
81
|
+
let webhookId: string; //Webhook ID. (default to undefined)
|
|
82
|
+
|
|
83
|
+
const { status, data } = await apiInstance.webhooksControllerDeleteWebhook(
|
|
84
|
+
webhookId
|
|
85
|
+
);
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Parameters
|
|
89
|
+
|
|
90
|
+
|Name | Type | Description | Notes|
|
|
91
|
+
|------------- | ------------- | ------------- | -------------|
|
|
92
|
+
| **webhookId** | [**string**] | Webhook ID. | defaults to undefined|
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
### Return type
|
|
96
|
+
|
|
97
|
+
**WebhookDto**
|
|
98
|
+
|
|
99
|
+
### Authorization
|
|
100
|
+
|
|
101
|
+
No authorization required
|
|
102
|
+
|
|
103
|
+
### HTTP request headers
|
|
104
|
+
|
|
105
|
+
- **Content-Type**: Not defined
|
|
106
|
+
- **Accept**: application/json
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
### HTTP response details
|
|
110
|
+
| Status code | Description | Response headers |
|
|
111
|
+
|-------------|-------------|------------------|
|
|
112
|
+
|**200** | Webhook deleted | - |
|
|
113
|
+
|**401** | Unauthorized | - |
|
|
114
|
+
|**404** | Not found | - |
|
|
115
|
+
|
|
116
|
+
[[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)
|
|
117
|
+
|
|
118
|
+
# **webhooksControllerGetWebhook**
|
|
119
|
+
> WebhookDto webhooksControllerGetWebhook()
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
### Example
|
|
123
|
+
|
|
124
|
+
```typescript
|
|
125
|
+
import {
|
|
126
|
+
WebhooksApi,
|
|
127
|
+
Configuration
|
|
128
|
+
} from '@nestbox-ai/doc-processing-api';
|
|
129
|
+
|
|
130
|
+
const configuration = new Configuration();
|
|
131
|
+
const apiInstance = new WebhooksApi(configuration);
|
|
132
|
+
|
|
133
|
+
let webhookId: string; //Webhook ID. (default to undefined)
|
|
134
|
+
|
|
135
|
+
const { status, data } = await apiInstance.webhooksControllerGetWebhook(
|
|
136
|
+
webhookId
|
|
137
|
+
);
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Parameters
|
|
141
|
+
|
|
142
|
+
|Name | Type | Description | Notes|
|
|
143
|
+
|------------- | ------------- | ------------- | -------------|
|
|
144
|
+
| **webhookId** | [**string**] | Webhook ID. | defaults to undefined|
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
### Return type
|
|
148
|
+
|
|
149
|
+
**WebhookDto**
|
|
150
|
+
|
|
151
|
+
### Authorization
|
|
152
|
+
|
|
153
|
+
No authorization required
|
|
154
|
+
|
|
155
|
+
### HTTP request headers
|
|
156
|
+
|
|
157
|
+
- **Content-Type**: Not defined
|
|
158
|
+
- **Accept**: application/json
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
### HTTP response details
|
|
162
|
+
| Status code | Description | Response headers |
|
|
163
|
+
|-------------|-------------|------------------|
|
|
164
|
+
|**200** | Webhook details | - |
|
|
165
|
+
|**401** | Unauthorized | - |
|
|
166
|
+
|**404** | Not found | - |
|
|
167
|
+
|
|
168
|
+
[[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)
|
|
169
|
+
|
|
170
|
+
# **webhooksControllerListWebhooks**
|
|
171
|
+
> PaginatedWebhooksDto webhooksControllerListWebhooks()
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
### Example
|
|
175
|
+
|
|
176
|
+
```typescript
|
|
177
|
+
import {
|
|
178
|
+
WebhooksApi,
|
|
179
|
+
Configuration
|
|
180
|
+
} from '@nestbox-ai/doc-processing-api';
|
|
181
|
+
|
|
182
|
+
const configuration = new Configuration();
|
|
183
|
+
const apiInstance = new WebhooksApi(configuration);
|
|
184
|
+
|
|
185
|
+
let page: number; //1-based page number. (optional) (default to 1)
|
|
186
|
+
let limit: number; //Page size. (optional) (default to 10)
|
|
187
|
+
|
|
188
|
+
const { status, data } = await apiInstance.webhooksControllerListWebhooks(
|
|
189
|
+
page,
|
|
190
|
+
limit
|
|
191
|
+
);
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
### Parameters
|
|
195
|
+
|
|
196
|
+
|Name | Type | Description | Notes|
|
|
197
|
+
|------------- | ------------- | ------------- | -------------|
|
|
198
|
+
| **page** | [**number**] | 1-based page number. | (optional) defaults to 1|
|
|
199
|
+
| **limit** | [**number**] | Page size. | (optional) defaults to 10|
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
### Return type
|
|
203
|
+
|
|
204
|
+
**PaginatedWebhooksDto**
|
|
205
|
+
|
|
206
|
+
### Authorization
|
|
207
|
+
|
|
208
|
+
No authorization required
|
|
209
|
+
|
|
210
|
+
### HTTP request headers
|
|
211
|
+
|
|
212
|
+
- **Content-Type**: Not defined
|
|
213
|
+
- **Accept**: application/json
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
### HTTP response details
|
|
217
|
+
| Status code | Description | Response headers |
|
|
218
|
+
|-------------|-------------|------------------|
|
|
219
|
+
|**200** | Paginated list of webhooks | - |
|
|
220
|
+
|**401** | Unauthorized | - |
|
|
221
|
+
|
|
222
|
+
[[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)
|
|
223
|
+
|
|
224
|
+
# **webhooksControllerUpdateWebhook**
|
|
225
|
+
> WebhookDto webhooksControllerUpdateWebhook(updateWebhookBodyInputDto)
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
### Example
|
|
229
|
+
|
|
230
|
+
```typescript
|
|
231
|
+
import {
|
|
232
|
+
WebhooksApi,
|
|
233
|
+
Configuration,
|
|
234
|
+
UpdateWebhookBodyInputDto
|
|
235
|
+
} from '@nestbox-ai/doc-processing-api';
|
|
236
|
+
|
|
237
|
+
const configuration = new Configuration();
|
|
238
|
+
const apiInstance = new WebhooksApi(configuration);
|
|
239
|
+
|
|
240
|
+
let webhookId: string; //Webhook ID. (default to undefined)
|
|
241
|
+
let updateWebhookBodyInputDto: UpdateWebhookBodyInputDto; //
|
|
242
|
+
|
|
243
|
+
const { status, data } = await apiInstance.webhooksControllerUpdateWebhook(
|
|
244
|
+
webhookId,
|
|
245
|
+
updateWebhookBodyInputDto
|
|
246
|
+
);
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### Parameters
|
|
250
|
+
|
|
251
|
+
|Name | Type | Description | Notes|
|
|
252
|
+
|------------- | ------------- | ------------- | -------------|
|
|
253
|
+
| **updateWebhookBodyInputDto** | **UpdateWebhookBodyInputDto**| | |
|
|
254
|
+
| **webhookId** | [**string**] | Webhook ID. | defaults to undefined|
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
### Return type
|
|
258
|
+
|
|
259
|
+
**WebhookDto**
|
|
260
|
+
|
|
261
|
+
### Authorization
|
|
262
|
+
|
|
263
|
+
No authorization required
|
|
264
|
+
|
|
265
|
+
### HTTP request headers
|
|
266
|
+
|
|
267
|
+
- **Content-Type**: application/json
|
|
268
|
+
- **Accept**: application/json
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
### HTTP response details
|
|
272
|
+
| Status code | Description | Response headers |
|
|
273
|
+
|-------------|-------------|------------------|
|
|
274
|
+
|**200** | Webhook updated | - |
|
|
275
|
+
|**400** | Bad request | - |
|
|
276
|
+
|**401** | Unauthorized | - |
|
|
277
|
+
|**404** | Not found | - |
|
|
278
|
+
|
|
279
|
+
[[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)
|
|
280
|
+
|