azisaba-graph 0.1.0-rc.16

An API for connecting and sharing data across the Azisaba Network.
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366

# \PlayersApi

All URIs are relative to *https://graph.azisaba.net*

Method | HTTP request | Description
------------- | ------------- | -------------
[**accept_player_friend_request**](PlayersApi.md#accept_player_friend_request) | **PUT** /players/{playerId}/friend-requests/{senderId}/accept | Accept player friend request
[**add_player_friend**](PlayersApi.md#add_player_friend) | **PUT** /players/{playerId}/friends/{friendId} | Add player friend
[**add_player_friend_request**](PlayersApi.md#add_player_friend_request) | **PUT** /players/{playerId}/friend-requests/{senderId} | Add player friend request
[**get_player_by_id**](PlayersApi.md#get_player_by_id) | **GET** /players/{playerId} | Get player
[**list_player_friend_requests**](PlayersApi.md#list_player_friend_requests) | **GET** /players/{playerId}/friend-requests | List player friend requests
[**list_player_friends**](PlayersApi.md#list_player_friends) | **GET** /players/{playerId}/friends | List player friends
[**list_players**](PlayersApi.md#list_players) | **GET** /players | List players
[**reject_player_friend_request**](PlayersApi.md#reject_player_friend_request) | **PUT** /players/{playerId}/friend-requests/{senderId}/reject | Reject player friend request
[**remove_player_friend**](PlayersApi.md#remove_player_friend) | **DELETE** /players/{playerId}/friends/{friendId} | Remove player friend
[**remove_player_friend_request**](PlayersApi.md#remove_player_friend_request) | **DELETE** /players/{playerId}/friend-requests/{senderId} | Remove player friend request
[**update_player_by_id**](PlayersApi.md#update_player_by_id) | **PATCH** /players/{playerId} | Update player



## accept_player_friend_request

> accept_player_friend_request(player_id, sender_id)
Accept player friend request

Accepts the specified sender's friend request and adds the sender to the player's friends.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**player_id** | **uuid::Uuid** | The unique identifier of the player. | [required] |
**sender_id** | **uuid::Uuid** | The unique identifier of the player sending the friend request. | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

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


## add_player_friend

> models::Player add_player_friend(player_id, friend_id)
Add player friend

Adds the specified friend to the player's friends.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**player_id** | **uuid::Uuid** | The unique identifier of the player. | [required] |
**friend_id** | **uuid::Uuid** | The unique identifier of the friend player. | [required] |

### Return type

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

### Authorization

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

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


## add_player_friend_request

> add_player_friend_request(player_id, sender_id)
Add player friend request

Adds a friend request from the specified sender to the player's friend requests.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**player_id** | **uuid::Uuid** | The unique identifier of the player. | [required] |
**sender_id** | **uuid::Uuid** | The unique identifier of the player sending the friend request. | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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_player_by_id

> models::Player get_player_by_id(player_id)
Get player

Returns the player with the specified ID. The `discordId` field is `null` unless the API key has the `players:read-details` scope. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**player_id** | **uuid::Uuid** | The unique identifier of the player. | [required] |

### Return type

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

### Authorization

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

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

> models::ListPlayers200Response list_player_friend_requests(player_id, limit, cursor, sender_id)
List player friend requests

Returns a list of friend requests received by the specified player.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**player_id** | **uuid::Uuid** | The unique identifier of the player. | [required] |
**limit** | Option<**u8**> | The maximum number of friend requests to return. |  |[default to 20]
**cursor** | Option<**String**> | The cursor returned by the previous request. |  |
**sender_id** | Option<**uuid::Uuid**> | The unique identifier of the sender used to filter friend requests. |  |

### Return type

[**models::ListPlayers200Response**](listPlayers_200_response.md)

### Authorization

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

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

> models::ListPlayers200Response list_player_friends(player_id, limit, cursor, friend_id)
List player friends

Returns a list of friends of the specified player.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**player_id** | **uuid::Uuid** | The unique identifier of the player. | [required] |
**limit** | Option<**u8**> | The maximum number of friends to return. |  |[default to 20]
**cursor** | Option<**String**> | The cursor returned by the previous request. |  |
**friend_id** | Option<**uuid::Uuid**> | The unique identifier of the friend used to filter friendships. |  |

### Return type

[**models::ListPlayers200Response**](listPlayers_200_response.md)

### Authorization

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

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

> models::ListPlayers200Response list_players(limit, cursor, username, discord_id, status)
List players

Returns a list of players. The `discordId` field is `null` unless the API key has the `players:read-details` scope. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**u8**> | The maximum number of players to return. |  |[default to 20]
**cursor** | Option<**String**> | The cursor returned by the previous request. |  |
**username** | Option<**String**> | The username used to filter players. |  |
**discord_id** | Option<**String**> | The Discord user ID used to filter players. Requires the `players:read-details` scope. |  |
**status** | Option<**String**> | The online status used to filter players. |  |

### Return type

[**models::ListPlayers200Response**](listPlayers_200_response.md)

### Authorization

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

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


## reject_player_friend_request

> reject_player_friend_request(player_id, sender_id)
Reject player friend request

Rejects the specified sender's friend request and removes it from the player's friend requests.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**player_id** | **uuid::Uuid** | The unique identifier of the player. | [required] |
**sender_id** | **uuid::Uuid** | The unique identifier of the player sending the friend request. | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

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


## remove_player_friend

> remove_player_friend(player_id, friend_id)
Remove player friend

Removes the specified friend from the player's friends.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**player_id** | **uuid::Uuid** | The unique identifier of the player. | [required] |
**friend_id** | **uuid::Uuid** | The unique identifier of the friend player. | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

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


## remove_player_friend_request

> remove_player_friend_request(player_id, sender_id)
Remove player friend request

Removes the specified sender's friend request from the player's friend requests.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**player_id** | **uuid::Uuid** | The unique identifier of the player. | [required] |
**sender_id** | **uuid::Uuid** | The unique identifier of the player sending the friend request. | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

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


## update_player_by_id

> models::Player update_player_by_id(player_id, update_player_by_id_request)
Update player

Updates the player with the specified ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**player_id** | **uuid::Uuid** | The unique identifier of the player. | [required] |
**update_player_by_id_request** | [**UpdatePlayerByIdRequest**](UpdatePlayerByIdRequest.md) |  | [required] |

### Return type

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

### Authorization

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

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