edgegap 0.1.0

Auto-generated client library for the Edgegap API, used by the arbctl tool
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

# \SessionsApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_users_session**](SessionsApi.md#delete_users_session) | **DELETE** /v1/session/{session_id}/users | Delete Users From a Session
[**get_session**](SessionsApi.md#get_session) | **GET** /v1/session/{session_id} | Get a Session
[**get_users_session**](SessionsApi.md#get_users_session) | **GET** /v1/session/{session_id}/users | List Users of a Session
[**list_sessions**](SessionsApi.md#list_sessions) | **GET** /v1/sessions | List All Sessions
[**put_users_session**](SessionsApi.md#put_users_session) | **PUT** /v1/session/{session_id}/users | Put Users in a Session
[**session_delete**](SessionsApi.md#session_delete) | **DELETE** /v1/session/{session_id} | Delete a Session
[**session_post**](SessionsApi.md#session_post) | **POST** /v1/session | Create a Session
[**sessions_bulk_stop**](SessionsApi.md#sessions_bulk_stop) | **POST** /v1/sessions/bulk-stop | Delete Sessions in Bulk



## delete_users_session

> models::SessionUserContext delete_users_session(session_id, payload)
Delete Users From a Session

Remove specified users from a session.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**session_id** | **String** |  | [required] |
**payload** | [**PatchSessionModel**](PatchSessionModel.md) |  | [required] |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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


## get_session

> models::SessionGet get_session(session_id)
Get a Session

Retrieve the information for a session.

### Parameters


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

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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

> models::SessionUserContext get_users_session(session_id)
List Users of a Session

List all the users of session.

### Parameters


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

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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

> models::Sessions list_sessions()
List All Sessions

List all the active sessions.

### Parameters

This endpoint does not need any parameter.

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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


## put_users_session

> models::SessionUserContext put_users_session(session_id, payload)
Put Users in a Session

Add specified users to a session.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**session_id** | **String** |  | [required] |
**payload** | [**PatchSessionModel**](PatchSessionModel.md) |  | [required] |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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


## session_delete

> models::SessionDelete session_delete(session_id)
Delete a Session

Delete a session. Once deleted, a session is no more accessible and does not have a history. The deployment associated will not be deleted.

### Parameters


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

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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


## session_post

> models::SessionRequest session_post(payload)
Create a Session

Create a session with users. Sessions are linked to a deployment.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**payload** | [**SessionModel**](SessionModel.md) |  | [required] |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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


## sessions_bulk_stop

> models::SessionBulkStopResponse sessions_bulk_stop(payload)
Delete Sessions in Bulk

Make a bulk delete of sessions using filters. All the sessions matching the given filters will be permanently deleted.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**payload** | [**SessionBulkStopPayload**](SessionBulkStopPayload.md) |  | [required] |

### Return type

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

### Authorization

[apiKey](../README.md#apiKey)

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