windmill-api 1.848.2

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

# \WorkspaceIntegrationApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**check_if_native_triggers_service_exists**](WorkspaceIntegrationApi.md#check_if_native_triggers_service_exists) | **GET** /w/{workspace}/native_triggers/integrations/{service_name}/exists | check if integrations for a particular service exists
[**check_instance_sharing_available**](WorkspaceIntegrationApi.md#check_instance_sharing_available) | **GET** /w/{workspace}/native_triggers/integrations/{service_name}/instance_sharing_available | check if instance-level credential sharing is available for a service
[**create_native_trigger_service**](WorkspaceIntegrationApi.md#create_native_trigger_service) | **POST** /w/{workspace}/native_triggers/integrations/{service_name}/create | create native trigger service
[**delete_native_trigger_connection**](WorkspaceIntegrationApi.md#delete_native_trigger_connection) | **DELETE** /w/{workspace}/native_triggers/integrations/{service_name}/connections/delete | disconnect a native trigger connection and delete the triggers using it
[**delete_native_trigger_service**](WorkspaceIntegrationApi.md#delete_native_trigger_service) | **DELETE** /w/{workspace}/native_triggers/integrations/{service_name}/delete | delete native trigger service
[**generate_native_trigger_service_connect_url**](WorkspaceIntegrationApi.md#generate_native_trigger_service_connect_url) | **POST** /w/{workspace}/native_triggers/integrations/{service_name}/generate_connect_url | generate connect url for native trigger service
[**list_native_trigger_connections**](WorkspaceIntegrationApi.md#list_native_trigger_connections) | **GET** /w/{workspace}/native_triggers/integrations/{service_name}/connections | list the native trigger connections of a service the caller can use
[**list_native_trigger_services**](WorkspaceIntegrationApi.md#list_native_trigger_services) | **GET** /w/{workspace}/native_triggers/integrations/list | list available native trigger services
[**native_trigger_service_callback**](WorkspaceIntegrationApi.md#native_trigger_service_callback) | **POST** /w/{workspace}/native_triggers/integrations/{service_name}/callback | native trigger service oauth callback
[**set_native_trigger_workspace_connection**](WorkspaceIntegrationApi.md#set_native_trigger_workspace_connection) | **POST** /w/{workspace}/native_triggers/integrations/{service_name}/workspace_connection | share a connection of this service with every member of the workspace (admin only), or stop sharing



## check_if_native_triggers_service_exists

> bool check_if_native_triggers_service_exists(workspace, service_name)
check if integrations for a particular service exists

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [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)


## check_instance_sharing_available

> bool check_instance_sharing_available(workspace, service_name)
check if instance-level credential sharing is available for a service

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [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)


## create_native_trigger_service

> String create_native_trigger_service(workspace, service_name, workspace_o_auth_config)
create native trigger service

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [required] |
**workspace_o_auth_config** | [**WorkspaceOAuthConfig**](WorkspaceOAuthConfig.md) | new native trigger service | [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)


## delete_native_trigger_connection

> String delete_native_trigger_connection(workspace, service_name, path)
disconnect a native trigger connection and delete the triggers using it

### Parameters


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

### Return type

**String**

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


## delete_native_trigger_service

> String delete_native_trigger_service(workspace, service_name)
delete native trigger service

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [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)


## generate_native_trigger_service_connect_url

> String generate_native_trigger_service_connect_url(workspace, service_name, generate_native_trigger_service_connect_url_request)
generate connect url for native trigger service

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [required] |
**generate_native_trigger_service_connect_url_request** | [**GenerateNativeTriggerServiceConnectUrlRequest**](GenerateNativeTriggerServiceConnectUrlRequest.md) | redirect_uri, and where to save the connection (defaults to u/{caller}/native_{resource_type}). Uses the workspace OAuth client, or the instance one when the instance shares it. | [required] |

### Return type

**String**

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


## list_native_trigger_connections

> Vec<models::NativeTriggerConnection> list_native_trigger_connections(workspace, service_name)
list the native trigger connections of a service the caller can use

### Parameters


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

### Return type

[**Vec<models::NativeTriggerConnection>**](NativeTriggerConnection.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_trigger_services

> Vec<models::WorkspaceIntegrations> list_native_trigger_services(workspace)
list available native trigger services

### Parameters


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

### Return type

[**Vec<models::WorkspaceIntegrations>**](WorkspaceIntegrations.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_service_callback

> String native_trigger_service_callback(workspace, service_name, native_trigger_service_callback_request)
native trigger service oauth callback

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**service_name** | [**NativeServiceName**](.md) |  | [required] |
**native_trigger_service_callback_request** | [**NativeTriggerServiceCallbackRequest**](NativeTriggerServiceCallbackRequest.md) | OAuth callback data | [required] |

### Return type

**String**

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


## set_native_trigger_workspace_connection

> String set_native_trigger_workspace_connection(workspace, service_name, set_native_trigger_workspace_connection_request)
share a connection of this service with every member of the workspace (admin only), or stop sharing

### Parameters


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

### Return type

**String**

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