chore(app): сгенерированный Dart-клиент из OpenAPI
openapi-generator-cli -g dart-dio. Генерируется, но коммитится: CI ловит дрейф openapi/openapi.json, а приложение собирается без запуска генератора. Пересобирается через just gen-client после любого изменения роутов.
This commit is contained in:
Dmitry
@@ -0,0 +1,20 @@
|
||||
# fintracker_api.model.AccountBalance
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accountId** | **int** | |
|
||||
**balance** | **String** | decimal as string |
|
||||
**balanceRub** | **String** | decimal as string |
|
||||
**currency** | **String** | |
|
||||
**name** | **String** | |
|
||||
**role** | [**AccountRole**](AccountRole.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)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# fintracker_api.model.AccountKind
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# fintracker_api.model.AccountOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**archived** | **bool** | |
|
||||
**balance** | **String** | decimal as string |
|
||||
**balanceAsOf** | [**DateTime**](DateTime.md) | |
|
||||
**broker** | [**Broker**](Broker.md) | |
|
||||
**creditLimit** | **String** | decimal as string |
|
||||
**currency** | **String** | |
|
||||
**id** | **int** | |
|
||||
**includeInNetWorth** | **bool** | |
|
||||
**kind** | [**AccountKind**](AccountKind.md) | |
|
||||
**mirrorOfAccountId** | **int** | |
|
||||
**name** | **String** | |
|
||||
**openedAt** | [**DateTime**](DateTime.md) | |
|
||||
**primaryEventSource** | [**EventSource**](EventSource.md) | |
|
||||
**role** | [**AccountRole**](AccountRole.md) | |
|
||||
**source_** | **String** | |
|
||||
**sourceId** | **String** | |
|
||||
**startBalance** | **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)
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# fintracker_api.model.AccountPatch
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**includeInNetWorth** | **bool** | | [optional]
|
||||
**mirrorOfAccountId** | **int** | | [optional]
|
||||
**name** | **String** | | [optional]
|
||||
**primaryEventSource** | [**EventSource**](EventSource.md) | | [optional]
|
||||
**role** | [**AccountRole**](AccountRole.md) | | [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)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# fintracker_api.model.AccountRole
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,99 @@
|
||||
# fintracker_api.api.AccountsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**accountsList**](AccountsApi.md#accountslist) | **GET** /api/v1/accounts | List
|
||||
[**accountsPatch**](AccountsApi.md#accountspatch) | **PATCH** /api/v1/accounts/{account_id} | Patch
|
||||
|
||||
|
||||
# **accountsList**
|
||||
> List<AccountOut> accountsList()
|
||||
|
||||
List
|
||||
|
||||
Every account, archived ones included — the client decides what to show.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAccountsApi();
|
||||
|
||||
try {
|
||||
final response = api.accountsList();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AccountsApi->accountsList: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<AccountOut>**](AccountOut.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)
|
||||
|
||||
# **accountsPatch**
|
||||
> AccountOut accountsPatch(accountId, accountPatch)
|
||||
|
||||
Patch
|
||||
|
||||
Update the user-owned fields. Everything else is overwritten by the next sync.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAccountsApi();
|
||||
final int accountId = 56; // int |
|
||||
final AccountPatch accountPatch = ; // AccountPatch |
|
||||
|
||||
try {
|
||||
final response = api.accountsPatch(accountId, accountPatch);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AccountsApi->accountsPatch: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**accountId** | **int**| |
|
||||
**accountPatch** | [**AccountPatch**](AccountPatch.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)
|
||||
|
||||
@@ -0,0 +1,176 @@
|
||||
# fintracker_api.api.AuthApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**authLogin**](AuthApi.md#authlogin) | **POST** /api/v1/auth/login | Login
|
||||
[**authLogout**](AuthApi.md#authlogout) | **POST** /api/v1/auth/logout | Logout
|
||||
[**authMe**](AuthApi.md#authme) | **GET** /api/v1/auth/me | Me
|
||||
[**authRefresh**](AuthApi.md#authrefresh) | **POST** /api/v1/auth/refresh | Refresh
|
||||
|
||||
|
||||
# **authLogin**
|
||||
> TokenPair authLogin(loginRequest)
|
||||
|
||||
Login
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAuthApi();
|
||||
final LoginRequest loginRequest = ; // LoginRequest |
|
||||
|
||||
try {
|
||||
final response = api.authLogin(loginRequest);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AuthApi->authLogin: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**loginRequest** | [**LoginRequest**](LoginRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**TokenPair**](TokenPair.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### 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)
|
||||
|
||||
# **authLogout**
|
||||
> authLogout(refreshRequest)
|
||||
|
||||
Logout
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAuthApi();
|
||||
final RefreshRequest refreshRequest = ; // RefreshRequest |
|
||||
|
||||
try {
|
||||
api.authLogout(refreshRequest);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AuthApi->authLogout: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**refreshRequest** | [**RefreshRequest**](RefreshRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **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)
|
||||
|
||||
# **authMe**
|
||||
> UserOut authMe()
|
||||
|
||||
Me
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAuthApi();
|
||||
|
||||
try {
|
||||
final response = api.authMe();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AuthApi->authMe: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**UserOut**](UserOut.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)
|
||||
|
||||
# **authRefresh**
|
||||
> TokenPair authRefresh(refreshRequest)
|
||||
|
||||
Refresh
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getAuthApi();
|
||||
final RefreshRequest refreshRequest = ; // RefreshRequest |
|
||||
|
||||
try {
|
||||
final response = api.authRefresh(refreshRequest);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling AuthApi->authRefresh: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**refreshRequest** | [**RefreshRequest**](RefreshRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**TokenPair**](TokenPair.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### 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)
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# fintracker_api.model.Broker
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# fintracker_api.model.CashFlowMonth
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**baselineRub** | **String** | decimal as string |
|
||||
**expenseRub** | **String** | decimal as string |
|
||||
**incomeRub** | **String** | decimal as string |
|
||||
**month** | [**DateTime**](DateTime.md) | |
|
||||
**oneOffRub** | **String** | decimal as string |
|
||||
**savingsRate** | **String** | decimal as string |
|
||||
**savingsTransferRub** | **String** | decimal as string |
|
||||
**txnCount** | **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,141 @@
|
||||
# fintracker_api.api.CashflowApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**cashflowMonthly**](CashflowApi.md#cashflowmonthly) | **GET** /api/v1/cashflow/monthly | Monthly
|
||||
[**cashflowRunway**](CashflowApi.md#cashflowrunway) | **GET** /api/v1/runway | Runway
|
||||
[**cashflowSpending**](CashflowApi.md#cashflowspending) | **GET** /api/v1/spending/categories | Spending
|
||||
|
||||
|
||||
# **cashflowMonthly**
|
||||
> List<CashFlowMonth> cashflowMonthly(months)
|
||||
|
||||
Monthly
|
||||
|
||||
The last `months` months, oldest first.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getCashflowApi();
|
||||
final int months = 56; // int |
|
||||
|
||||
try {
|
||||
final response = api.cashflowMonthly(months);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling CashflowApi->cashflowMonthly: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**months** | **int**| | [optional] [default to 12]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<CashFlowMonth>**](CashFlowMonth.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)
|
||||
|
||||
# **cashflowRunway**
|
||||
> RunwayOut cashflowRunway()
|
||||
|
||||
Runway
|
||||
|
||||
How many months the liquid reserve covers; null before the first refresh.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getCashflowApi();
|
||||
|
||||
try {
|
||||
final response = api.cashflowRunway();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling CashflowApi->cashflowRunway: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**RunwayOut**](RunwayOut.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)
|
||||
|
||||
# **cashflowSpending**
|
||||
> List<SpendingRow> cashflowSpending(month)
|
||||
|
||||
Spending
|
||||
|
||||
Expenses of one month by category, largest first.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getCashflowApi();
|
||||
final String month = month_example; // String | YYYY-MM; defaults to the latest month
|
||||
|
||||
try {
|
||||
final response = api.cashflowSpending(month);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling CashflowApi->cashflowSpending: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**month** | **String**| YYYY-MM; defaults to the latest month | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<SpendingRow>**](SpendingRow.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)
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
# fintracker_api.api.CategoriesApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**categoriesList**](CategoriesApi.md#categorieslist) | **GET** /api/v1/categories | List
|
||||
|
||||
|
||||
# **categoriesList**
|
||||
> List<CategoryOut> categoriesList()
|
||||
|
||||
List
|
||||
|
||||
Flat list of the ZenMoney tag tree; the client nests it by `parent_id`.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getCategoriesApi();
|
||||
|
||||
try {
|
||||
final response = api.categoriesList();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling CategoriesApi->categoriesList: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<CategoryOut>**](CategoryOut.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)
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# fintracker_api.model.CategoryOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**archived** | **bool** | |
|
||||
**color** | **int** | |
|
||||
**icon** | **String** | |
|
||||
**id** | **int** | |
|
||||
**name** | **String** | |
|
||||
**parentId** | **int** | |
|
||||
**showIncome** | **bool** | |
|
||||
**showOutcome** | **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,21 @@
|
||||
# fintracker_api.model.DataQualityRow
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**checkName** | **String** | |
|
||||
**computedAt** | [**DateTime**](DateTime.md) | |
|
||||
**count** | **int** | |
|
||||
**detail** | **String** | |
|
||||
**id** | **int** | |
|
||||
**ref** | **Map<String, Object>** | |
|
||||
**severity** | **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,14 @@
|
||||
# fintracker_api.model.EventSource
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# fintracker_api.model.FlowType
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# fintracker_api.model.Health
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**database** | **String** | |
|
||||
**status** | **String** | |
|
||||
**version** | **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,51 @@
|
||||
# fintracker_api.api.HealthApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**healthCheck**](HealthApi.md#healthcheck) | **GET** /api/v1/health | Check
|
||||
|
||||
|
||||
# **healthCheck**
|
||||
> Health healthCheck()
|
||||
|
||||
Check
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getHealthApi();
|
||||
|
||||
try {
|
||||
final response = api.healthCheck();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling HealthApi->healthCheck: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**Health**](Health.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### 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)
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# fintracker_api.model.JobStatus
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# fintracker_api.model.LoginRequest
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **String** | |
|
||||
**password** | **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,133 @@
|
||||
# fintracker_api.api.MetricsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**metricsDataQuality**](MetricsApi.md#metricsdataquality) | **GET** /api/v1/data-quality | Data Quality
|
||||
[**metricsRefresh**](MetricsApi.md#metricsrefresh) | **POST** /api/v1/metrics/refresh | Refresh
|
||||
[**metricsStatus**](MetricsApi.md#metricsstatus) | **GET** /api/v1/metrics/status | Status
|
||||
|
||||
|
||||
# **metricsDataQuality**
|
||||
> List<DataQualityRow> metricsDataQuality()
|
||||
|
||||
Data Quality
|
||||
|
||||
Findings of the latest refresh, most serious first.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getMetricsApi();
|
||||
|
||||
try {
|
||||
final response = api.metricsDataQuality();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling MetricsApi->metricsDataQuality: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<DataQualityRow>**](DataQualityRow.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)
|
||||
|
||||
# **metricsRefresh**
|
||||
> RefreshLogOut metricsRefresh()
|
||||
|
||||
Refresh
|
||||
|
||||
Rebuild every metric_* table inline (seconds at personal volumes).
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getMetricsApi();
|
||||
|
||||
try {
|
||||
final response = api.metricsRefresh();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling MetricsApi->metricsRefresh: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**RefreshLogOut**](RefreshLogOut.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)
|
||||
|
||||
# **metricsStatus**
|
||||
> RefreshLogOut metricsStatus()
|
||||
|
||||
Status
|
||||
|
||||
When the metric tables were last rebuilt, and whether it failed.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getMetricsApi();
|
||||
|
||||
try {
|
||||
final response = api.metricsStatus();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling MetricsApi->metricsStatus: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**RefreshLogOut**](RefreshLogOut.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)
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# fintracker_api.model.NetWorthBreakdown
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accounts** | [**List<AccountBalance>**](AccountBalance.md) | |
|
||||
**byCurrency** | **Map<String, String>** | |
|
||||
**d** | [**DateTime**](DateTime.md) | |
|
||||
**debtRub** | **String** | decimal as string |
|
||||
**investmentRub** | **String** | decimal as string |
|
||||
**liquidRub** | **String** | decimal as string |
|
||||
**missingFxCount** | **int** | |
|
||||
**savingsRub** | **String** | decimal as string |
|
||||
**totalRub** | **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)
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# fintracker_api.model.NetWorthDay
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**byCurrency** | **Map<String, String>** | |
|
||||
**d** | [**DateTime**](DateTime.md) | |
|
||||
**debtRub** | **String** | decimal as string |
|
||||
**investmentRub** | **String** | decimal as string |
|
||||
**liquidRub** | **String** | decimal as string |
|
||||
**missingFxCount** | **int** | |
|
||||
**savingsRub** | **String** | decimal as string |
|
||||
**totalRub** | **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)
|
||||
|
||||
|
||||
@@ -0,0 +1,99 @@
|
||||
# fintracker_api.api.NetworthApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**networthBreakdown**](NetworthApi.md#networthbreakdown) | **GET** /api/v1/networth/breakdown | Breakdown
|
||||
[**networthSeries**](NetworthApi.md#networthseries) | **GET** /api/v1/networth/series | Series
|
||||
|
||||
|
||||
# **networthBreakdown**
|
||||
> NetWorthBreakdown networthBreakdown()
|
||||
|
||||
Breakdown
|
||||
|
||||
The latest day's buckets, plus every account's current balance native and in RUB.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getNetworthApi();
|
||||
|
||||
try {
|
||||
final response = api.networthBreakdown();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling NetworthApi->networthBreakdown: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**NetWorthBreakdown**](NetWorthBreakdown.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)
|
||||
|
||||
# **networthSeries**
|
||||
> List<NetWorthDay> networthSeries(from, to)
|
||||
|
||||
Series
|
||||
|
||||
Daily net worth; defaults to the last 365 days.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getNetworthApi();
|
||||
final DateTime from = 2013-10-20; // DateTime |
|
||||
final DateTime to = 2013-10-20; // DateTime |
|
||||
|
||||
try {
|
||||
final response = api.networthSeries(from, to);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling NetworthApi->networthSeries: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**from** | **DateTime**| | [optional]
|
||||
**to** | **DateTime**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<NetWorthDay>**](NetWorthDay.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)
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.Problem
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**detail** | **String** | | [optional]
|
||||
**errors** | **List<Object>** | | [optional]
|
||||
**status** | **int** | |
|
||||
**title** | **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,19 @@
|
||||
# fintracker_api.model.RefreshLogOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**error** | **String** | |
|
||||
**finishedAt** | [**DateTime**](DateTime.md) | |
|
||||
**id** | **int** | |
|
||||
**startedAt** | [**DateTime**](DateTime.md) | |
|
||||
**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,15 @@
|
||||
# fintracker_api.model.RefreshRequest
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**refreshToken** | **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,21 @@
|
||||
# fintracker_api.model.RuleCreate
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enabled** | **bool** | | [optional] [default to true]
|
||||
**kind** | [**RuleKind**](RuleKind.md) | |
|
||||
**matchType** | [**RuleMatchType**](RuleMatchType.md) | |
|
||||
**note** | **String** | | [optional]
|
||||
**pattern** | **String** | |
|
||||
**priority** | **int** | | [optional] [default to 100]
|
||||
**value** | **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)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# fintracker_api.model.RuleKind
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# fintracker_api.model.RuleMatchType
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
# fintracker_api.model.RuleOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enabled** | **bool** | |
|
||||
**id** | **int** | |
|
||||
**kind** | [**RuleKind**](RuleKind.md) | |
|
||||
**lastMatchedAt** | [**DateTime**](DateTime.md) | |
|
||||
**matchCount** | **int** | |
|
||||
**matchType** | [**RuleMatchType**](RuleMatchType.md) | |
|
||||
**note** | **String** | |
|
||||
**pattern** | **String** | |
|
||||
**priority** | **int** | |
|
||||
**value** | **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,21 @@
|
||||
# fintracker_api.model.RulePatch
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enabled** | **bool** | | [optional]
|
||||
**kind** | [**RuleKind**](RuleKind.md) | | [optional]
|
||||
**matchType** | [**RuleMatchType**](RuleMatchType.md) | | [optional]
|
||||
**note** | **String** | | [optional]
|
||||
**pattern** | **String** | | [optional]
|
||||
**priority** | **int** | | [optional]
|
||||
**value** | **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)
|
||||
|
||||
|
||||
@@ -0,0 +1,258 @@
|
||||
# fintracker_api.api.RulesApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**rulesApply**](RulesApi.md#rulesapply) | **POST** /api/v1/rules/apply | Apply
|
||||
[**rulesCreate**](RulesApi.md#rulescreate) | **POST** /api/v1/rules | Create
|
||||
[**rulesDelete**](RulesApi.md#rulesdelete) | **DELETE** /api/v1/rules/{rule_id} | Delete
|
||||
[**rulesList**](RulesApi.md#ruleslist) | **GET** /api/v1/rules | List
|
||||
[**rulesPatch**](RulesApi.md#rulespatch) | **PATCH** /api/v1/rules/{rule_id} | Patch
|
||||
[**rulesStale**](RulesApi.md#rulesstale) | **GET** /api/v1/rules/stale | Stale
|
||||
|
||||
|
||||
# **rulesApply**
|
||||
> RefreshLogOut rulesApply()
|
||||
|
||||
Apply
|
||||
|
||||
Re-run the whole metric refresh so edited rules take effect everywhere at once.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getRulesApi();
|
||||
|
||||
try {
|
||||
final response = api.rulesApply();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling RulesApi->rulesApply: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**RefreshLogOut**](RefreshLogOut.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)
|
||||
|
||||
# **rulesCreate**
|
||||
> RuleOut rulesCreate(ruleCreate)
|
||||
|
||||
Create
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getRulesApi();
|
||||
final RuleCreate ruleCreate = ; // RuleCreate |
|
||||
|
||||
try {
|
||||
final response = api.rulesCreate(ruleCreate);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling RulesApi->rulesCreate: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ruleCreate** | [**RuleCreate**](RuleCreate.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**RuleOut**](RuleOut.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)
|
||||
|
||||
# **rulesDelete**
|
||||
> rulesDelete(ruleId)
|
||||
|
||||
Delete
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getRulesApi();
|
||||
final int ruleId = 56; // int |
|
||||
|
||||
try {
|
||||
api.rulesDelete(ruleId);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling RulesApi->rulesDelete: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ruleId** | **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)
|
||||
|
||||
# **rulesList**
|
||||
> List<RuleOut> rulesList()
|
||||
|
||||
List
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getRulesApi();
|
||||
|
||||
try {
|
||||
final response = api.rulesList();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling RulesApi->rulesList: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<RuleOut>**](RuleOut.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)
|
||||
|
||||
# **rulesPatch**
|
||||
> RuleOut rulesPatch(ruleId, rulePatch)
|
||||
|
||||
Patch
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getRulesApi();
|
||||
final int ruleId = 56; // int |
|
||||
final RulePatch rulePatch = ; // RulePatch |
|
||||
|
||||
try {
|
||||
final response = api.rulesPatch(ruleId, rulePatch);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling RulesApi->rulesPatch: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ruleId** | **int**| |
|
||||
**rulePatch** | [**RulePatch**](RulePatch.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**RuleOut**](RuleOut.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)
|
||||
|
||||
# **rulesStale**
|
||||
> List<RuleOut> rulesStale()
|
||||
|
||||
Stale
|
||||
|
||||
Enabled rules that matched nothing in the latest refresh: the payee was renamed, or the transaction was re-categorised in ZenMoney.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getRulesApi();
|
||||
|
||||
try {
|
||||
final response = api.rulesStale();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling RulesApi->rulesStale: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<RuleOut>**](RuleOut.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)
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# fintracker_api.model.RunStatus
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.RunwayOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**asOf** | [**DateTime**](DateTime.md) | |
|
||||
**avgBaseline3mRub** | **String** | decimal as string |
|
||||
**liquidReserveRub** | **String** | decimal as string |
|
||||
**runwayMonths** | **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)
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# fintracker_api.model.SourceStatus
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**cursor** | **String** | |
|
||||
**lastRunAt** | [**DateTime**](DateTime.md) | |
|
||||
**lastRunStatus** | [**RunStatus**](RunStatus.md) | |
|
||||
**lastSuccessAt** | [**DateTime**](DateTime.md) | |
|
||||
**queued** | **bool** | |
|
||||
**source_** | **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,21 @@
|
||||
# fintracker_api.model.SpendingRow
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**amountRub** | **String** | decimal as string |
|
||||
**categoryId** | **int** | |
|
||||
**categoryName** | **String** | |
|
||||
**month** | [**DateTime**](DateTime.md) | |
|
||||
**rootCategoryId** | **int** | |
|
||||
**rootCategoryName** | **String** | |
|
||||
**txnCount** | **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,137 @@
|
||||
# fintracker_api.api.SyncApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**syncRuns**](SyncApi.md#syncruns) | **GET** /api/v1/sync/runs | Runs
|
||||
[**syncStatus**](SyncApi.md#syncstatus) | **GET** /api/v1/sync/status | Status
|
||||
[**syncTrigger**](SyncApi.md#synctrigger) | **POST** /api/v1/sync/{source} | Trigger
|
||||
|
||||
|
||||
# **syncRuns**
|
||||
> List<SyncRunOut> syncRuns(source_, limit)
|
||||
|
||||
Runs
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getSyncApi();
|
||||
final String source_ = source__example; // String |
|
||||
final int limit = 56; // int |
|
||||
|
||||
try {
|
||||
final response = api.syncRuns(source_, limit);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling SyncApi->syncRuns: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**source_** | **String**| | [optional]
|
||||
**limit** | **int**| | [optional] [default to 20]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<SyncRunOut>**](SyncRunOut.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)
|
||||
|
||||
# **syncStatus**
|
||||
> List<SourceStatus> syncStatus()
|
||||
|
||||
Status
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getSyncApi();
|
||||
|
||||
try {
|
||||
final response = api.syncStatus();
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling SyncApi->syncStatus: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<SourceStatus>**](SourceStatus.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)
|
||||
|
||||
# **syncTrigger**
|
||||
> SyncJobOut syncTrigger(source_)
|
||||
|
||||
Trigger
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getSyncApi();
|
||||
final String source_ = source__example; // String |
|
||||
|
||||
try {
|
||||
final response = api.syncTrigger(source_);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling SyncApi->syncTrigger: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**source_** | **String**| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**SyncJobOut**](SyncJobOut.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)
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.SyncJobOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | |
|
||||
**requestedAt** | [**DateTime**](DateTime.md) | |
|
||||
**source_** | **String** | |
|
||||
**status** | [**JobStatus**](JobStatus.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)
|
||||
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
# fintracker_api.model.SyncRunOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**counts** | **Map<String, Object>** | |
|
||||
**cursorAfter** | **String** | |
|
||||
**cursorBefore** | **String** | |
|
||||
**error** | **String** | |
|
||||
**finishedAt** | [**DateTime**](DateTime.md) | |
|
||||
**id** | **String** | |
|
||||
**source_** | **String** | |
|
||||
**startedAt** | [**DateTime**](DateTime.md) | |
|
||||
**status** | [**RunStatus**](RunStatus.md) | |
|
||||
**triggeredBy** | **String** | |
|
||||
**warnings** | **List<Object>** | |
|
||||
|
||||
[[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.TokenPair
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accessToken** | **String** | |
|
||||
**expiresIn** | **int** | |
|
||||
**refreshToken** | **String** | |
|
||||
**tokenType** | **String** | | [optional] [default to 'bearer']
|
||||
|
||||
[[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,37 @@
|
||||
# fintracker_api.model.TransactionOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**categoryId** | **int** | |
|
||||
**comment** | **String** | |
|
||||
**date** | [**DateTime**](DateTime.md) | |
|
||||
**deleted** | **bool** | |
|
||||
**flowType** | [**FlowType**](FlowType.md) | |
|
||||
**hold** | **bool** | |
|
||||
**id** | **int** | |
|
||||
**income** | **String** | decimal as string |
|
||||
**incomeAccountId** | **int** | |
|
||||
**incomeCurrency** | **String** | |
|
||||
**incomeRub** | **String** | decimal as string |
|
||||
**isOneOff** | **bool** | |
|
||||
**mcc** | **int** | |
|
||||
**outcome** | **String** | decimal as string |
|
||||
**outcomeAccountId** | **int** | |
|
||||
**outcomeCurrency** | **String** | |
|
||||
**outcomeRub** | **String** | decimal as string |
|
||||
**payee** | **String** | |
|
||||
**payeeCanonical** | **String** | |
|
||||
**sourceId** | **String** | |
|
||||
**tags** | **List<int>** | |
|
||||
**tripId** | **int** | |
|
||||
**ts** | [**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)
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# fintracker_api.model.TransactionPage
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**items** | [**List<TransactionOut>**](TransactionOut.md) | |
|
||||
**page** | **int** | |
|
||||
**pageSize** | **int** | |
|
||||
**total** | **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,73 @@
|
||||
# fintracker_api.api.TransactionsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**transactionsList**](TransactionsApi.md#transactionslist) | **GET** /api/v1/transactions | List
|
||||
|
||||
|
||||
# **transactionsList**
|
||||
> TransactionPage transactionsList(from, to, accountId, categoryId, flowType, q, includeDeleted, page, pageSize)
|
||||
|
||||
List
|
||||
|
||||
One page of transactions, newest first, with RUB amounts at each own date's rate.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
|
||||
final api = FintrackerApi().getTransactionsApi();
|
||||
final DateTime from = 2013-10-20; // DateTime |
|
||||
final DateTime to = 2013-10-20; // DateTime |
|
||||
final int accountId = 56; // int |
|
||||
final int categoryId = 56; // int |
|
||||
final FlowType flowType = ; // FlowType |
|
||||
final String q = q_example; // String | substring of payee or comment
|
||||
final bool includeDeleted = true; // bool |
|
||||
final int page = 56; // int |
|
||||
final int pageSize = 56; // int |
|
||||
|
||||
try {
|
||||
final response = api.transactionsList(from, to, accountId, categoryId, flowType, q, includeDeleted, page, pageSize);
|
||||
print(response);
|
||||
} on DioException catch (e) {
|
||||
print('Exception when calling TransactionsApi->transactionsList: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**from** | **DateTime**| | [optional]
|
||||
**to** | **DateTime**| | [optional]
|
||||
**accountId** | **int**| | [optional]
|
||||
**categoryId** | **int**| | [optional]
|
||||
**flowType** | [**FlowType**](.md)| | [optional]
|
||||
**q** | **String**| substring of payee or comment | [optional]
|
||||
**includeDeleted** | **bool**| | [optional] [default to false]
|
||||
**page** | **int**| | [optional] [default to 1]
|
||||
**pageSize** | **int**| | [optional] [default to 50]
|
||||
|
||||
### Return type
|
||||
|
||||
[**TransactionPage**](TransactionPage.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)
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# fintracker_api.model.UserOut
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:fintracker_api/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**email** | **String** | |
|
||||
**id** | **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)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user