revolt_api 0.6.5

Open source user-first chat platform.
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

# \ServerPermissionsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**permissions_set_default_req**](ServerPermissionsApi.md#permissions_set_default_req) | **PUT** /servers/{target}/permissions/default | Set Default Permission
[**permissions_set_req**](ServerPermissionsApi.md#permissions_set_req) | **PUT** /servers/{target}/permissions/{role_id} | Set Role Permission
[**roles_create_req**](ServerPermissionsApi.md#roles_create_req) | **POST** /servers/{target}/roles | Create Role
[**roles_delete_req**](ServerPermissionsApi.md#roles_delete_req) | **DELETE** /servers/{target}/roles/{role_id} | Delete Role
[**roles_edit_req**](ServerPermissionsApi.md#roles_edit_req) | **PATCH** /servers/{target}/roles/{role_id} | Edit Role



## permissions_set_default_req

> crate::models::Server permissions_set_default_req(target, data_permissions_value)
Set Default Permission

Sets permissions for the default role in this server.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**target** | **String** |  | [required] |
**data_permissions_value** | [**DataPermissionsValue**](DataPermissionsValue.md) |  | [required] |

### Return type

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


## permissions_set_req

> crate::models::Server permissions_set_req(target, role_id, data_set_server_role_permission)
Set Role Permission

Sets permissions for the specified role in the server.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**target** | **String** |  | [required] |
**role_id** | **String** |  | [required] |
**data_set_server_role_permission** | [**DataSetServerRolePermission**](DataSetServerRolePermission.md) |  | [required] |

### Return type

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


## roles_create_req

> crate::models::NewRoleResponse roles_create_req(target, data_create_role)
Create Role

Creates a new server role.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**target** | **String** |  | [required] |
**data_create_role** | [**DataCreateRole**](DataCreateRole.md) |  | [required] |

### Return type

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


## roles_delete_req

> roles_delete_req(target, role_id)
Delete Role

Delete a server role by its id.

### Parameters


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

### Return type

 (empty response body)

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


## roles_edit_req

> crate::models::Role roles_edit_req(target, role_id, data_edit_role)
Edit Role

Edit a role by its id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**target** | **String** |  | [required] |
**role_id** | **String** |  | [required] |
**data_edit_role** | [**DataEditRole**](DataEditRole.md) |  | [required] |

### Return type

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