chore(app): перегенерировать Dart-клиент
Портфели, создание счетов, ручные события, PATCH инструмента, ScopeCardOut, MetricsStatusOut, логотипы в HoldingOut.
This commit is contained in:
Dmitry
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.AccountCreate
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**broker** | [**Broker**](Broker.md) | |
|
||||
**currency** | **String** | | [optional] [default to 'RUB']
|
||||
**name** | **String** | |
|
||||
**sourceId** | **String** | Agreement number exactly as the broker's report prints it |
|
||||
|
||||
[[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,6 +14,7 @@ Name | Type | Description | Notes
|
||||
**broker** | [**Broker**](Broker.md) | |
|
||||
**creditLimit** | **String** | decimal as string |
|
||||
**currency** | **String** | |
|
||||
**disabled** | **bool** | |
|
||||
**id** | **int** | |
|
||||
**includeInNetWorth** | **bool** | |
|
||||
**kind** | [**AccountKind**](AccountKind.md) | |
|
||||
@@ -25,6 +26,7 @@ Name | Type | Description | Notes
|
||||
**source_** | **String** | |
|
||||
**sourceId** | **String** | |
|
||||
**startBalance** | **String** | decimal as string |
|
||||
**valueRub** | **String** | decimal as string | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -8,6 +8,7 @@ import 'package:fintracker_api/api.dart';
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**disabled** | **bool** | | [optional]
|
||||
**includeInNetWorth** | **bool** | | [optional]
|
||||
**mirrorOfAccountId** | **int** | | [optional]
|
||||
**name** | **String** | | [optional]
|
||||
|
||||
@@ -9,10 +9,54 @@ All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**accountsCreate**](AccountsApi.md#accountscreate) | **POST** /api/v1/accounts | Create
|
||||
[**accountsList**](AccountsApi.md#accountslist) | **GET** /api/v1/accounts | List
|
||||
[**accountsPatch**](AccountsApi.md#accountspatch) | **PATCH** /api/v1/accounts/{account_id} | Patch
|
||||
|
||||
|
||||
# **accountsCreate**
|
||||
> AccountOut accountsCreate(accountCreate)
|
||||
|
||||
Create
|
||||
|
||||
Create the broker account a report import will write into. `source_id` is the agreement number the report prints: it is how the import finds the account on its own the next time.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAccountsApi();
|
||||
final AccountCreate accountCreate = ; // AccountCreate |
|
||||
|
||||
try {
|
||||
final response = api.accountsCreate(accountCreate);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AccountsApi->accountsCreate: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**accountCreate** | [**AccountCreate**](AccountCreate.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccountOut**](AccountOut.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)
|
||||
|
||||
# **accountsList**
|
||||
> List<AccountOut> accountsList()
|
||||
|
||||
|
||||
@@ -12,6 +12,7 @@ Method | HTTP request | Description
|
||||
[**analyticsAllocation**](AnalyticsApi.md#analyticsallocation) | **GET** /api/v1/analytics/allocation | Allocation
|
||||
[**analyticsCashflowBroker**](AnalyticsApi.md#analyticscashflowbroker) | **GET** /api/v1/analytics/cashflow-broker | Cashflow Broker
|
||||
[**analyticsHoldings**](AnalyticsApi.md#analyticsholdings) | **GET** /api/v1/analytics/holdings | Holdings
|
||||
[**analyticsOverview**](AnalyticsApi.md#analyticsoverview) | **GET** /api/v1/analytics/overview | Overview
|
||||
[**analyticsReturns**](AnalyticsApi.md#analyticsreturns) | **GET** /api/v1/analytics/returns | Returns
|
||||
[**analyticsScopes**](AnalyticsApi.md#analyticsscopes) | **GET** /api/v1/analytics/scopes | Scopes
|
||||
[**analyticsSummary**](AnalyticsApi.md#analyticssummary) | **GET** /api/v1/analytics/summary | Summary
|
||||
@@ -149,6 +150,45 @@ Name | Type | Description | Notes
|
||||
|
||||
[[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)
|
||||
|
||||
# **analyticsOverview**
|
||||
> List<ScopeCardOut> analyticsOverview()
|
||||
|
||||
Overview
|
||||
|
||||
One card per scope for the home screen, in a single round trip. `all` first, then the portfolios, then the accounts by value. A scope holding nothing at all is left out: a card of zeros is noise, not an answer.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAnalyticsApi();
|
||||
|
||||
try {
|
||||
final response = api.analyticsOverview();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AnalyticsApi->analyticsOverview: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<ScopeCardOut>**](ScopeCardOut.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)
|
||||
|
||||
# **analyticsReturns**
|
||||
> List<ReturnsOut> analyticsReturns(scope)
|
||||
|
||||
|
||||
@@ -22,6 +22,7 @@ Name | Type | Description | Notes
|
||||
**price** | **String** | decimal as string |
|
||||
**priceCurrency** | **String** | |
|
||||
**quantity** | **String** | decimal as string |
|
||||
**source_** | **String** | |
|
||||
**status** | [**EventStatus**](EventStatus.md) | |
|
||||
**tax** | **String** | decimal as string |
|
||||
**ticker** | **String** | |
|
||||
|
||||
@@ -9,9 +9,96 @@ All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**eventsCreate**](EventsApi.md#eventscreate) | **POST** /api/v1/events | Create
|
||||
[**eventsDelete**](EventsApi.md#eventsdelete) | **DELETE** /api/v1/events/{event_id} | Delete
|
||||
[**eventsList**](EventsApi.md#eventslist) | **GET** /api/v1/events | List
|
||||
|
||||
|
||||
# **eventsCreate**
|
||||
> EventOut eventsCreate(manualEventCreate)
|
||||
|
||||
Create
|
||||
|
||||
Enter an event by hand. It is `confirmed` at once: it is the user's own statement, so it is never shadowed by the account's primary feed.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getEventsApi();
|
||||
final ManualEventCreate manualEventCreate = ; // ManualEventCreate |
|
||||
|
||||
try {
|
||||
final response = api.eventsCreate(manualEventCreate);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling EventsApi->eventsCreate: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**manualEventCreate** | [**ManualEventCreate**](ManualEventCreate.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**EventOut**](EventOut.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)
|
||||
|
||||
# **eventsDelete**
|
||||
> eventsDelete(eventId)
|
||||
|
||||
Delete
|
||||
|
||||
Delete an event that was entered by hand. Broker events are evidence, not ours to erase: the next sync or import would bring them straight back.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getEventsApi();
|
||||
final int eventId = 56; // int |
|
||||
|
||||
try {
|
||||
api.eventsDelete(eventId);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling EventsApi->eventsDelete: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**eventId** | **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)
|
||||
|
||||
# **eventsList**
|
||||
> EventPage eventsList(from, to, accountId, instrumentId, kind, status, externalFlow, q, page, pageSize)
|
||||
|
||||
|
||||
@@ -17,6 +17,8 @@ Method | HTTP request | Description
|
||||
|
||||
Check
|
||||
|
||||
503 when the database cannot be reached, so a container healthcheck can trust the code.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
@@ -20,6 +20,8 @@ Name | Type | Description | Notes
|
||||
**incomeRub** | **String** | decimal as string |
|
||||
**instrumentId** | **int** | |
|
||||
**ldvEligibleQty** | **String** | decimal as string |
|
||||
**logoColor** | **String** | | [optional]
|
||||
**logoUrl** | **String** | | [optional]
|
||||
**marketPrice** | **String** | decimal as string |
|
||||
**name** | **String** | |
|
||||
**priceCurrency** | **String** | |
|
||||
|
||||
@@ -18,6 +18,8 @@ Name | Type | Description | Notes
|
||||
**isActive** | **bool** | |
|
||||
**isin** | **String** | |
|
||||
**issuer** | **String** | |
|
||||
**logoColor** | **String** | | [optional]
|
||||
**logoUrl** | **String** | | [optional]
|
||||
**lot** | **int** | |
|
||||
**maturityDate** | [**DateTime**](DateTime.md) | |
|
||||
**name** | **String** | |
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# fintracker_api.model.InstrumentPatch
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**assetClass** | **String** | | [optional]
|
||||
**board** | **String** | | [optional]
|
||||
**lot** | **int** | | [optional]
|
||||
**name** | **String** | | [optional]
|
||||
**sector** | **String** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**instrumentsGet**](InstrumentsApi.md#instrumentsget) | **GET** /api/v1/instruments/{instrument_id} | Get
|
||||
[**instrumentsList**](InstrumentsApi.md#instrumentslist) | **GET** /api/v1/instruments | List
|
||||
[**instrumentsPatch**](InstrumentsApi.md#instrumentspatch) | **PATCH** /api/v1/instruments/{instrument_id} | Patch
|
||||
[**instrumentsPending**](InstrumentsApi.md#instrumentspending) | **GET** /api/v1/instruments/pending | Pending
|
||||
[**instrumentsPendingResolve**](InstrumentsApi.md#instrumentspendingresolve) | **POST** /api/v1/instruments/pending/{pending_id}/resolve | Pending Resolve
|
||||
[**instrumentsSetManualPrice**](InstrumentsApi.md#instrumentssetmanualprice) | **POST** /api/v1/instruments/{instrument_id}/prices | Set Manual Price
|
||||
@@ -110,6 +111,51 @@ Name | Type | Description | Notes
|
||||
|
||||
[[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)
|
||||
|
||||
# **instrumentsPatch**
|
||||
> InstrumentOut instrumentsPatch(instrumentId, instrumentPatch)
|
||||
|
||||
Patch
|
||||
|
||||
Correct an instrument by hand: name, board, lot, asset class, sector. The lot only rounds the quantities the rebalancing suggests; the asset class decides the bucket it lands in. Neither is refreshed here — call `POST /metrics/refresh` after, same as `/rules/apply`.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getInstrumentsApi();
|
||||
final int instrumentId = 56; // int |
|
||||
final InstrumentPatch instrumentPatch = ; // InstrumentPatch |
|
||||
|
||||
try {
|
||||
final response = api.instrumentsPatch(instrumentId, instrumentPatch);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling InstrumentsApi->instrumentsPatch: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**instrumentId** | **int**| |
|
||||
**instrumentPatch** | [**InstrumentPatch**](InstrumentPatch.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**InstrumentOut**](InstrumentOut.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)
|
||||
|
||||
# **instrumentsPending**
|
||||
> List<PendingInstrumentOut> instrumentsPending(status, limit, offset)
|
||||
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
# fintracker_api.model.ManualEventCreate
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountId** | **int** | |
|
||||
**accruedInterest** | **String** | decimal as string | [optional]
|
||||
**amount** | **String** | decimal as string | [optional]
|
||||
**currency** | **String** | | [optional]
|
||||
**description** | **String** | | [optional]
|
||||
**fee** | **String** | decimal as string | [optional]
|
||||
**instrumentId** | **int** | | [optional]
|
||||
**kind** | [**EventKind**](EventKind.md) | |
|
||||
**price** | **String** | decimal as string | [optional]
|
||||
**quantity** | **String** | decimal as string | [optional]
|
||||
**tradeDate** | [**DateTime**](DateTime.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)
|
||||
|
||||
|
||||
@@ -54,11 +54,11 @@ This endpoint does not need any parameter.
|
||||
[[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)
|
||||
|
||||
# **metricsRefresh**
|
||||
> RefreshLogOut metricsRefresh()
|
||||
> SyncJobOut metricsRefresh()
|
||||
|
||||
Refresh
|
||||
|
||||
Rebuild every metric_* table inline (seconds at personal volumes).
|
||||
Queue a rebuild of every metric_* table; the worker runs it. Poll `/metrics/status` until `refreshing` is false. A request while one is already waiting shares it. One that arrives while a rebuild is RUNNING queues another, because the running one may have read the data before the change that prompted this call.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
@@ -79,7 +79,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**RefreshLogOut**](RefreshLogOut.md)
|
||||
[**SyncJobOut**](SyncJobOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -93,11 +93,11 @@ This endpoint does not need any parameter.
|
||||
[[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)
|
||||
|
||||
# **metricsStatus**
|
||||
> RefreshLogOut metricsStatus()
|
||||
> MetricsStatusOut metricsStatus()
|
||||
|
||||
Status
|
||||
|
||||
When the metric tables were last rebuilt, and whether it failed.
|
||||
When the metric tables were last rebuilt, whether they are one consistent snapshot, and whether another rebuild is on its way.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
@@ -118,7 +118,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**RefreshLogOut**](RefreshLogOut.md)
|
||||
[**MetricsStatusOut**](MetricsStatusOut.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# fintracker_api.model.MetricsStatusOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**consistent** | **bool** | |
|
||||
**lastRefresh** | [**RefreshLogOut**](RefreshLogOut.md) | |
|
||||
**refreshing** | **bool** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
# fintracker_api.model.PortfolioAccountsIn
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountIds** | **List<int>** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# fintracker_api.model.PortfolioCreate
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountIds** | **List<int>** | | [optional]
|
||||
**name** | **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)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.PortfolioOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountIds** | **List<int>** | |
|
||||
**baseCurrency** | **String** | |
|
||||
**id** | **int** | |
|
||||
**name** | **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)
|
||||
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
# fintracker_api.model.PortfolioPatch
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **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)
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -9,9 +9,11 @@ import 'package:fintracker_api/api.dart';
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**error** | **String** | |
|
||||
**failedStep** | **String** | |
|
||||
**finishedAt** | [**DateTime**](DateTime.md) | |
|
||||
**id** | **int** | |
|
||||
**startedAt** | [**DateTime**](DateTime.md) | |
|
||||
**stepTimings** | **Map<String, num>** | |
|
||||
**trigger** | **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)
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
# fintracker_api.model.ScopeCardOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asOf** | [**DateTime**](DateTime.md) | |
|
||||
**dayChangePct** | **String** | decimal as string |
|
||||
**dayChangeRub** | **String** | decimal as string |
|
||||
**incomeYearPct** | **String** | decimal as string |
|
||||
**incomeYearRub** | **String** | decimal as string |
|
||||
**investedRub** | **String** | decimal as string |
|
||||
**kind** | **String** | |
|
||||
**name** | **String** | |
|
||||
**pnlPct** | **String** | decimal as string |
|
||||
**pnlRub** | **String** | decimal as string |
|
||||
**scope** | **String** | |
|
||||
**totalRub** | **String** | decimal as string |
|
||||
**xirr** | **String** | decimal as 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)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user