vrchatapi 1.19.4

VRChat API Client for Rust
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

# \PrintsApi

All URIs are relative to *https://api.vrchat.cloud/api/1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_print**](PrintsApi.md#delete_print) | **DELETE** /prints/{printId} | Delete Print
[**edit_print**](PrintsApi.md#edit_print) | **POST** /prints/{printId} | Edit Print
[**get_print**](PrintsApi.md#get_print) | **GET** /prints/{printId} | Get Print
[**get_user_prints**](PrintsApi.md#get_user_prints) | **GET** /prints/user/{userId} | Get Own Prints
[**upload_print**](PrintsApi.md#upload_print) | **POST** /prints | Upload Print



## delete_print

> delete_print(print_id)
Delete Print

Returns a print.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**print_id** | **String** | Print ID. | [required] |

### Return type

 (empty response body)

### Authorization

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

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


## edit_print

> models::Print edit_print(print_id, image, note)
Edit Print

Edits a print.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**print_id** | **String** | Print ID. | [required] |
**image** | **std::path::PathBuf** | The binary blob of the png file. | [required] |
**note** | Option<**String**> | The caption for the image. |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: multipart/form-data
- **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_print

> models::Print get_print(print_id)
Get Print

Returns a print.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**print_id** | **String** | Print ID. | [required] |

### Return type

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

### Authorization

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

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


## get_user_prints

> Vec<models::Print> get_user_prints(user_id)
Get Own Prints

Returns a list of all prints of the user. User id has to be your own userId, as you can't request other user's prints.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | Must be a valid user ID. | [required] |

### Return type

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

### Authorization

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

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


## upload_print

> models::Print upload_print(image, timestamp, note, world_id, world_name)
Upload Print

Uploads and creates a print.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**image** | **std::path::PathBuf** | The binary blob of the png file. | [required] |
**timestamp** | **String** | The time the image was captured. | [required] |
**note** | Option<**String**> | The caption for the image. |  |
**world_id** | Option<**String**> | The id of the world in which the image was captured. |  |
**world_name** | Option<**String**> | The name of the world in which the image was captured. |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: multipart/form-data
- **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)