revolt_api 0.5.5

Rust typings for the Revolt API.
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

# \SyncApi

All URIs are relative to *https://api.revolt.chat*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_settings_req**](SyncApi.md#get_settings_req) | **POST** /sync/settings/fetch | Fetch Settings
[**get_unreads_req**](SyncApi.md#get_unreads_req) | **GET** /sync/unreads | Fetch Unreads
[**set_settings_req**](SyncApi.md#set_settings_req) | **POST** /sync/settings/set | Set Settings



## get_settings_req

> ::std::collections::HashMap<String, crate::models::Array> get_settings_req(options_fetch_settings)
Fetch Settings

Fetch settings from server filtered by keys.  This will return an object with the requested keys, each value is a tuple of `(timestamp, value)`, the value is the previously uploaded data.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**options_fetch_settings** | [**OptionsFetchSettings**](OptionsFetchSettings.md) |  | [required] |

### Return type

[**::std::collections::HashMap<String, crate::models::Array>**](array.md)

### Authorization

[Session Token](../README.md#Session Token)

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

> Vec<crate::models::ChannelUnread> get_unreads_req()
Fetch Unreads

Fetch information about unread state on channels.

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<crate::models::ChannelUnread>**](ChannelUnread.md)

### Authorization

[Session Token](../README.md#Session Token)

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


## set_settings_req

> set_settings_req(request_body, timestamp)
Set Settings

Upload data to save to settings.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**request_body** | [**::std::collections::HashMap<String, String>**](String.md) |  | [required] |
**timestamp** | Option<**i64**> | Timestamp of settings change.  Used to avoid feedback loops. |  |

### Return type

 (empty response body)

### Authorization

[Session Token](../README.md#Session Token)

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