windmill-api 1.846.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

# \SlackAgentsApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_agent_slack_channels**](SlackAgentsApi.md#get_agent_slack_channels) | **GET** /w/{workspace}/slack_agents/agent_channels/{path} | the Slack channels an agent is shared in, and whether the caller can share it
[**get_slack_agents_status**](SlackAgentsApi.md#get_slack_agents_status) | **GET** /w/{workspace}/slack_agents/status | whether agents can answer in Slack on this instance
[**list_available_slack_channels**](SlackAgentsApi.md#list_available_slack_channels) | **GET** /w/{workspace}/slack_agents/available_channels | list the connected Slack workspace's public channels
[**list_slack_agent_channels**](SlackAgentsApi.md#list_slack_agent_channels) | **GET** /w/{workspace}/slack_agents/channels | list the Slack channels this workspace's agents are shared in
[**share_agent_in_slack_channel**](SlackAgentsApi.md#share_agent_in_slack_channel) | **POST** /w/{workspace}/slack_agents/agent_channels/{path} | share an agent in a Slack channel, or change how it answers there
[**unshare_agent_from_slack_channel**](SlackAgentsApi.md#unshare_agent_from_slack_channel) | **DELETE** /w/{workspace}/slack_agents/agent_channels/{path} | stop sharing an agent in a Slack channel



## get_agent_slack_channels

> models::GetAgentSlackChannels200Response get_agent_slack_channels(workspace, path)
the Slack channels an agent is shared in, and whether the caller can share it

### Parameters


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

### Return type

[**models::GetAgentSlackChannels200Response**](getAgentSlackChannels_200_response.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)


## get_slack_agents_status

> models::GetSlackAgentsStatus200Response get_slack_agents_status(workspace)
whether agents can answer in Slack on this instance

### Parameters


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

### Return type

[**models::GetSlackAgentsStatus200Response**](getSlackAgentsStatus_200_response.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_available_slack_channels

> models::ListAvailableSlackChannels200Response list_available_slack_channels(workspace, cursor)
list the connected Slack workspace's public channels

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**cursor** | Option<**String**> | the next_cursor of the previous page |  |

### Return type

[**models::ListAvailableSlackChannels200Response**](listAvailableSlackChannels_200_response.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_slack_agent_channels

> Vec<models::SlackAgentChannel> list_slack_agent_channels(workspace)
list the Slack channels this workspace's agents are shared in

### Parameters


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

### Return type

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


## share_agent_in_slack_channel

> String share_agent_in_slack_channel(workspace, path, share_agent_in_slack_channel_request)
share an agent in a Slack channel, or change how it answers there

the workspace members in the channel whose Slack email matches and who can read the agent can then ask it, or anyone there when its settings say so (slack_anyone, with run_on_behalf_of). Needs edit access to the agent; making it the channel's default takes an admin.

### Parameters


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


## unshare_agent_from_slack_channel

> String unshare_agent_from_slack_channel(workspace, path, channel_id)
stop sharing an agent in a Slack channel

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**channel_id** | **String** |  | [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)