chore(app): перегенерировать Dart-клиент
Портфели, создание счетов, ручные события, PATCH инструмента, ScopeCardOut, MetricsStatusOut, логотипы в HoldingOut.
This commit is contained in:
@@ -0,0 +1,222 @@
|
||||
# fintracker_api.api.PortfoliosApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**portfoliosCreate**](PortfoliosApi.md#portfolioscreate) | **POST** /api/v1/portfolios | Create
|
||||
[**portfoliosDelete**](PortfoliosApi.md#portfoliosdelete) | **DELETE** /api/v1/portfolios/{portfolio_id} | Delete
|
||||
[**portfoliosList**](PortfoliosApi.md#portfolioslist) | **GET** /api/v1/portfolios | List
|
||||
[**portfoliosPatch**](PortfoliosApi.md#portfoliospatch) | **PATCH** /api/v1/portfolios/{portfolio_id} | Patch
|
||||
[**portfoliosSetAccounts**](PortfoliosApi.md#portfoliossetaccounts) | **PUT** /api/v1/portfolios/{portfolio_id}/accounts | Set Accounts
|
||||
|
||||
|
||||
# **portfoliosCreate**
|
||||
> PortfolioOut portfoliosCreate(portfolioCreate)
|
||||
|
||||
Create
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getPortfoliosApi();
|
||||
final PortfolioCreate portfolioCreate = ; // PortfolioCreate |
|
||||
|
||||
try {
|
||||
final response = api.portfoliosCreate(portfolioCreate);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling PortfoliosApi->portfoliosCreate: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**portfolioCreate** | [**PortfolioCreate**](PortfolioCreate.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PortfolioOut**](PortfolioOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/problem+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)
|
||||
|
||||
# **portfoliosDelete**
|
||||
> portfoliosDelete(portfolioId)
|
||||
|
||||
Delete
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getPortfoliosApi();
|
||||
final int portfolioId = 56; // int |
|
||||
|
||||
try {
|
||||
api.portfoliosDelete(portfolioId);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling PortfoliosApi->portfoliosDelete: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**portfolioId** | **int**| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/problem+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)
|
||||
|
||||
# **portfoliosList**
|
||||
> List<PortfolioOut> portfoliosList()
|
||||
|
||||
List
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getPortfoliosApi();
|
||||
|
||||
try {
|
||||
final response = api.portfoliosList();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling PortfoliosApi->portfoliosList: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<PortfolioOut>**](PortfolioOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/problem+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)
|
||||
|
||||
# **portfoliosPatch**
|
||||
> PortfolioOut portfoliosPatch(portfolioId, portfolioPatch)
|
||||
|
||||
Patch
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getPortfoliosApi();
|
||||
final int portfolioId = 56; // int |
|
||||
final PortfolioPatch portfolioPatch = ; // PortfolioPatch |
|
||||
|
||||
try {
|
||||
final response = api.portfoliosPatch(portfolioId, portfolioPatch);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling PortfoliosApi->portfoliosPatch: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**portfolioId** | **int**| |
|
||||
**portfolioPatch** | [**PortfolioPatch**](PortfolioPatch.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PortfolioOut**](PortfolioOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/problem+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)
|
||||
|
||||
# **portfoliosSetAccounts**
|
||||
> PortfolioOut portfoliosSetAccounts(portfolioId, portfolioAccountsIn)
|
||||
|
||||
Set Accounts
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getPortfoliosApi();
|
||||
final int portfolioId = 56; // int |
|
||||
final PortfolioAccountsIn portfolioAccountsIn = ; // PortfolioAccountsIn |
|
||||
|
||||
try {
|
||||
final response = api.portfoliosSetAccounts(portfolioId, portfolioAccountsIn);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling PortfoliosApi->portfoliosSetAccounts: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**portfolioId** | **int**| |
|
||||
**portfolioAccountsIn** | [**PortfolioAccountsIn**](PortfolioAccountsIn.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PortfolioOut**](PortfolioOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[HTTPBearer](../README.md#HTTPBearer)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json, application/problem+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)
|
||||
|
||||
Reference in New Issue
Block a user