mii/vrchatapi-rust
1
0
Fork 0
mirror of https://github.com/mii443/vrchatapi-rust.git synced 2025-08-22 23:55:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Upgrade Rust SDK to spec 1.5.2

Browse Source
This commit is contained in:
VRCCat
2021-10-31 01:17:08 +00:00
parent 7567269b87
commit f8357416a6
33 changed files with 1132 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
docs/EconomyApi.md Normal file
View File

@ -0,0 +1,154 @@
# \EconomyApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_current_subscriptions**](EconomyApi.md#get_current_subscriptions) | **GET** /auth/user/subscription | Get Current Subscriptions
[**get_license_group**](EconomyApi.md#get_license_group) | **GET** /licenseGroups/{licenseGroupId} | Get License Group
[**get_steam_transaction**](EconomyApi.md#get_steam_transaction) | **GET** /Steam/transactions/{transactionId} | Get Steam Transaction
[**get_steam_transactions**](EconomyApi.md#get_steam_transactions) | **GET** /Steam/transactions | List Steam Transactions
[**get_subscriptions**](EconomyApi.md#get_subscriptions) | **GET** /subscriptions | List Subscriptions
## get_current_subscriptions
> Vec<crate::models::UserSubscription> get_current_subscriptions()
Get Current Subscriptions
Get a list of all current user subscriptions.
### Parameters
This endpoint does not need any parameter.
### Return type
[**Vec<crate::models::UserSubscription>**](UserSubscription.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [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_license_group
> crate::models::LicenseGroup get_license_group(license_group_id)
Get License Group
Get a single License Group by given ID.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**license_group_id** | **String** | | [required] |
### Return type
[**crate::models::LicenseGroup**](LicenseGroup.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [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_steam_transaction
> crate::models::Transaction get_steam_transaction(transaction_id)
Get Steam Transaction
Get a single Steam transactions by ID. This returns the exact same information as `getSteamTransactions`, so no point in using this endpoint.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**transaction_id** | **String** | | [required] |
### Return type
[**crate::models::Transaction**](Transaction.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [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_steam_transactions
> Vec<crate::models::Transaction> get_steam_transactions()
List Steam Transactions
Get all own Steam transactions.
### Parameters
This endpoint does not need any parameter.
### Return type
[**Vec<crate::models::Transaction>**](Transaction.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [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_subscriptions
> Vec<crate::models::Subscription> get_subscriptions()
List Subscriptions
List all existing Subscriptions. For example, \"vrchatplus-monthly\" and \"vrchatplus-yearly\".
### Parameters
This endpoint does not need any parameter.
### Return type
[**Vec<crate::models::Subscription>**](Subscription.md)
### Authorization
[apiKeyCookie](../README.md#apiKeyCookie), [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)

2
docs/InviteApi.md
View File

@ -143,7 +143,7 @@ Name | Type | Description | Required | Notes
> Vec<crate::models::InviteMessage> reset_invite_message(user_id, message_type, slot)
Reset Invite Message
Resets a single Invite Message back to it's original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. Resetting it does however not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 \"Too Fast Error\". Message type refers to a different collection of messages, used during different types of responses. * `message` = Message during a normal invite * `response` = Message when replying to a message * `request` = Message when requesting an invite * `requestResponse` = Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
### Parameters

14
docs/License.md Normal file
View File

@ -0,0 +1,14 @@
# License
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**for_id** | **String** | Either a AvatarID, LicenseGroupID, PermissionID or ProductID. This depends on the `forType` field. |
**for_type** | [**crate::models::LicenseType**](LicenseType.md) | |
**for_name** | **String** | |
**for_action** | [**crate::models::LicenseAction**](LicenseAction.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

3
docs/InlineResponse404.md → docs/LicenseAction.md
View File

@ -1,10 +1,9 @@
# InlineResponse404
# LicenseAction
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**error** | [**crate::models::Error**](Error.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
docs/LicenseGroup.md Normal file
View File

@ -0,0 +1,14 @@
# LicenseGroup
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**name** | **String** | |
**description** | **String** | |
**licenses** | [**Vec<crate::models::License>**](License.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/LicenseType.md Normal file
View File

@ -0,0 +1,10 @@
# LicenseType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
docs/Subscription.md Normal file
View File

@ -0,0 +1,16 @@
# Subscription
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**steam_item_id** | **String** | |
**amount** | **f32** | |
**description** | **String** | |
**period** | [**crate::models::SubscriptionPeriod**](SubscriptionPeriod.md) | |
**tier** | **f32** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/SubscriptionPeriod.md Normal file
View File

@ -0,0 +1,10 @@
# SubscriptionPeriod
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
docs/Transaction.md Normal file
View File

@ -0,0 +1,19 @@
# Transaction
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**status** | [**crate::models::TransactionStatus**](TransactionStatus.md) | |
**subscription** | [**crate::models::Subscription**](Subscription.md) | |
**sandbox** | **bool** | | [default to false]
**created_at** | **String** | |
**updated_at** | **String** | |
**steam** | Option<[**crate::models::TransactionSteamInfo**](TransactionSteamInfo.md)> | | [optional]
**agreement** | Option<[**crate::models::TransactionAgreement**](TransactionAgreement.md)> | | [optional]
**error** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

27
docs/TransactionAgreement.md Normal file
View File

@ -0,0 +1,27 @@
# TransactionAgreement
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**agreement_id** | **String** | |
**item_id** | **f32** | |
**status** | **String** | This is NOT TransactionStatus, but whatever Steam return. |
**period** | **String** | |
**frequency** | **f32** | |
**billing_type** | **String** | |
**start_date** | **String** | |
**end_date** | **String** | |
**recurring_amt** | **f32** | |
**currency** | **String** | |
**time_created** | **String** | |
**next_payment** | **String** | |
**last_payment** | **String** | |
**last_amount** | **f32** | |
**last_amount_vat** | **f32** | |
**outstanding** | **f32** | |
**failed_attempts** | **f32** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
docs/TransactionStatus.md Normal file
View File

@ -0,0 +1,10 @@
# TransactionStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
docs/TransactionSteamInfo.md Normal file
View File

@ -0,0 +1,15 @@
# TransactionSteamInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**wallet_info** | [**crate::models::TransactionSteamWalletInfo**](TransactionSteamWalletInfo.md) | |
**steam_id** | **String** | Steam User ID |
**order_id** | **String** | Steam Order ID |
**steam_url** | **String** | Empty |
**trans_id** | **String** | Steam Transaction ID, NOT the same as VRChat TransactionID |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
docs/TransactionSteamWalletInfo.md Normal file
View File

@ -0,0 +1,14 @@
# TransactionSteamWalletInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**state** | **String** | |
**country** | **String** | | [default to US]
**currency** | **String** | | [default to USD]
**status** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

25
docs/UserSubscription.md Normal file
View File

@ -0,0 +1,25 @@
# UserSubscription
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | |
**transaction_id** | **String** | |
**store** | **String** | Which \"Store\" it came from. Right now only Stores are \"Steam\" and \"Admin\". |
**steam_item_id** | Option<**String**> | | [optional]
**amount** | **f32** | |
**description** | **String** | |
**period** | [**crate::models::SubscriptionPeriod**](SubscriptionPeriod.md) | |
**tier** | **f32** | |
**active** | **bool** | | [default to true]
**status** | [**crate::models::TransactionStatus**](TransactionStatus.md) | |
**expires** | **String** | |
**created_at** | **String** | |
**updated_at** | **String** | |
**license_groups** | **Vec<String>** | |
**is_gift** | **bool** | | [default to false]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)