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

# \RelaysApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**relay_session_create**](RelaysApi.md#relay_session_create) | **POST** /v1/relays/sessions | Create a Relay Session
[**relay_session_delete**](RelaysApi.md#relay_session_delete) | **DELETE** /v1/relays/sessions/{session_id} | Delete a Relay Session
[**relay_session_get**](RelaysApi.md#relay_session_get) | **GET** /v1/relays/sessions/{session_id} | Get a Relay Session
[**relay_session_list**](RelaysApi.md#relay_session_list) | **GET** /v1/relays/sessions | List all Relay Sessions
[**relay_user_authorize**](RelaysApi.md#relay_user_authorize) | **POST** /v1/relays/sessions:authorize-user | Authorize a user on a Relay Session
[**relay_user_revoke**](RelaysApi.md#relay_user_revoke) | **POST** /v1/relays/sessions:revoke-user | Remove a user on a Relay Session



## relay_session_create

> models::RelaySessionBaseResponse relay_session_create(payload)
Create a Relay Session

Create a relay session with users.

### Parameters


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

### Return type

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


## relay_session_delete

> relay_session_delete(session_id)
Delete a Relay Session

Delete a relay session.

### Parameters


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

### Return type

 (empty response body)

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


## relay_session_get

> models::RelaySessionBaseResponse relay_session_get(session_id)
Get a Relay Session

Retrieve the information for a relay session.

### Parameters


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

### Return type

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


## relay_session_list

> models::RelaySessionListResponse relay_session_list()
List all Relay Sessions

List all the active relay sessions.

### Parameters

This endpoint does not need any parameter.

### Return type

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


## relay_user_authorize

> models::RelaySessionUserBaseResponse relay_user_authorize(payload)
Authorize a user on a Relay Session

Authorize a user on a Relay Session

### Parameters


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

### Return type

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


## relay_user_revoke

> models::RelaySessionBaseResponse relay_user_revoke(payload)
Remove a user on a Relay Session

Authorize a user on a Relay Session

### Parameters


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

### Return type

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