windmill-api 1.680.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393

# \NativeTriggerApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_native_trigger**](NativeTriggerApi.md#create_native_trigger) | **POST** /w/{workspace}/native_triggers/{service_name}/create | create native trigger
[**delete_native_trigger**](NativeTriggerApi.md#delete_native_trigger) | **DELETE** /w/{workspace}/native_triggers/{service_name}/delete/{external_id} | delete native trigger
[**exists_native_trigger**](NativeTriggerApi.md#exists_native_trigger) | **GET** /w/{workspace}/native_triggers/{service_name}/exists/{external_id} | check if native trigger exists
[**get_native_trigger**](NativeTriggerApi.md#get_native_trigger) | **GET** /w/{workspace}/native_triggers/{service_name}/get/{external_id} | get native trigger
[**list_google_calendars**](NativeTriggerApi.md#list_google_calendars) | **GET** /w/{workspace}/native_triggers/google/calendars | list Google Calendars for the authenticated user
[**list_google_drive_files**](NativeTriggerApi.md#list_google_drive_files) | **GET** /w/{workspace}/native_triggers/google/drive/files | list or search Google Drive files
[**list_google_shared_drives**](NativeTriggerApi.md#list_google_shared_drives) | **GET** /w/{workspace}/native_triggers/google/drive/shared_drives | list shared drives accessible to the user
[**list_native_triggers**](NativeTriggerApi.md#list_native_triggers) | **GET** /w/{workspace}/native_triggers/{service_name}/list | list native triggers
[**list_next_cloud_events**](NativeTriggerApi.md#list_next_cloud_events) | **GET** /w/{workspace}/native_triggers/nextcloud/events | list available NextCloud events
[**native_trigger_webhook**](NativeTriggerApi.md#native_trigger_webhook) | **POST** /native_triggers/{service_name}/w/{workspace_id}/webhook/{internal_id} | receive webhook from external native trigger service
[**sync_native_triggers**](NativeTriggerApi.md#sync_native_triggers) | **POST** /w/{workspace}/native_triggers/{service_name}/sync | sync native triggers with external service
[**update_native_trigger**](NativeTriggerApi.md#update_native_trigger) | **POST** /w/{workspace}/native_triggers/{service_name}/update/{external_id} | update native trigger



## create_native_trigger

> models::CreateTriggerResponse create_native_trigger(workspace, service_name, native_trigger_data)
create native trigger

Creates a new native trigger for the specified service. Requires write access to the script or flow that the trigger will be associated with. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [required] |
**native_trigger_data** | [**NativeTriggerData**](NativeTriggerData.md) | new native trigger configuration | [required] |

### Return type

[**models::CreateTriggerResponse**](CreateTriggerResponse.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)


## delete_native_trigger

> String delete_native_trigger(workspace, service_name, external_id)
delete native trigger

Deletes a native trigger by its external ID. Requires write access to the script or flow that the trigger is associated with. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [required] |
**external_id** | **String** | The external ID of the trigger from the external service | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[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)


## exists_native_trigger

> bool exists_native_trigger(workspace, service_name, external_id)
check if native trigger exists

Checks if a native trigger with the given external ID exists.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [required] |
**external_id** | **String** | The external ID of the trigger from the external service | [required] |

### Return type

**bool**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## get_native_trigger

> models::NativeTriggerWithExternal get_native_trigger(workspace, service_name, external_id)
get native trigger

Retrieves a native trigger by its external ID. Requires write access to the script or flow that the trigger is associated with. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [required] |
**external_id** | **String** | The external ID of the trigger from the external service | [required] |

### Return type

[**models::NativeTriggerWithExternal**](NativeTriggerWithExternal.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## list_google_calendars

> Vec<models::GoogleCalendarEntry> list_google_calendars(workspace)
list Google Calendars for the authenticated user

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |

### Return type

[**Vec<models::GoogleCalendarEntry>**](GoogleCalendarEntry.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## list_google_drive_files

> models::GoogleDriveFilesResponse list_google_drive_files(workspace, q, parent_id, page_token, shared_with_me)
list or search Google Drive files

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**q** | Option<**String**> | search query to filter files by name |  |
**parent_id** | Option<**String**> | folder ID to list children of |  |
**page_token** | Option<**String**> | token for next page of results |  |
**shared_with_me** | Option<**bool**> | if true, list files shared with the user |  |[default to false]

### Return type

[**models::GoogleDriveFilesResponse**](GoogleDriveFilesResponse.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## list_google_shared_drives

> Vec<models::SharedDriveEntry> list_google_shared_drives(workspace)
list shared drives accessible to the user

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |

### Return type

[**Vec<models::SharedDriveEntry>**](SharedDriveEntry.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## list_native_triggers

> Vec<models::NativeTrigger> list_native_triggers(workspace, service_name, page, per_page, path, is_flow, label)
list native triggers

Lists all native triggers for the specified service in the workspace.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**path** | Option<**String**> | filter by script path |  |
**is_flow** | Option<**bool**> | filter by is_flow |  |
**label** | Option<**String**> | Filter by label |  |

### Return type

[**Vec<models::NativeTrigger>**](NativeTrigger.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## list_next_cloud_events

> Vec<models::NextCloudEventType> list_next_cloud_events(workspace)
list available NextCloud events

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |

### Return type

[**Vec<models::NextCloudEventType>**](NextCloudEventType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## native_trigger_webhook

> String native_trigger_webhook(service_name, workspace_id, internal_id, request_body)
receive webhook from external native trigger service

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**service_name** | [**NativeServiceName**](.md) |  | [required] |
**workspace_id** | **String** |  | [required] |
**internal_id** | **i64** | The internal database ID of the trigger | [required] |
**request_body** | Option<[**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md)> | webhook payload from external service |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json, text/plain
- **Accept**: text/plain

[[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)


## sync_native_triggers

> sync_native_triggers(workspace, service_name)
sync native triggers with external service

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## update_native_trigger

> String update_native_trigger(workspace, service_name, external_id, native_trigger_data)
update native trigger

Updates an existing native trigger. Requires write access to the script or flow that the trigger is associated with. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [required] |
**external_id** | **String** | The external ID of the trigger from the external service | [required] |
**native_trigger_data** | [**NativeTriggerData**](NativeTriggerData.md) | updated native trigger configuration | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[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)