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

# \LobbiesApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**lobby_create**](LobbiesApi.md#lobby_create) | **POST** /v1/lobbies | Create a Lobby
[**lobby_delete**](LobbiesApi.md#lobby_delete) | **DELETE** /v1/lobbies/{lobby_name} | Delete a Lobby
[**lobby_deploy**](LobbiesApi.md#lobby_deploy) | **POST** /v1/lobbies:deploy | Deploy a Lobby
[**lobby_get**](LobbiesApi.md#lobby_get) | **GET** /v1/lobbies/{lobby_name} | Get a Lobby
[**lobby_list**](LobbiesApi.md#lobby_list) | **GET** /v1/lobbies | List All Lobbies
[**lobby_terminate**](LobbiesApi.md#lobby_terminate) | **POST** /v1/lobbies:terminate | Terminate a Lobby



## lobby_create

> models::LobbyReadResponse lobby_create(payload)
Create a Lobby

Create a named lobby.

### Parameters


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

### Return type

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


## lobby_delete

> models::LobbyReadResponse lobby_delete(lobby_name)
Delete a Lobby

Delete a named lobby.

### Parameters


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

### Return type

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


## lobby_deploy

> models::LobbyReadResponse lobby_deploy(payload)
Deploy a Lobby

Deploy the lobby with the given name.

### Parameters


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

### Return type

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


## lobby_get

> models::LobbyReadResponse lobby_get(lobby_name)
Get a Lobby

Get a named lobby.

### Parameters


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

### Return type

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


## lobby_list

> models::LobbyReadResponse lobby_list()
List All Lobbies

List the Lobbies

### Parameters

This endpoint does not need any parameter.

### Return type

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


## lobby_terminate

> models::LobbyReadResponse lobby_terminate(payload)
Terminate a Lobby

Terminate the lobby with the given name.

### Parameters


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

### Return type

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