Dmitry
ccd06f32f7
just gen-client — покрывает links, cashflow-broker, ручные цены, imports/pending, goals/income/rebalance/tax/benchmarks.
141 lines
3.4 KiB
Markdown
141 lines
3.4 KiB
Markdown
# fintracker_api.api.LinksApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**linksCreate**](LinksApi.md#linkscreate) | **POST** /api/v1/links | Create
|
|
[**linksDelete**](LinksApi.md#linksdelete) | **DELETE** /api/v1/links/{link_id} | Delete
|
|
[**linksUnmatched**](LinksApi.md#linksunmatched) | **GET** /api/v1/links/unmatched | Unmatched
|
|
|
|
|
|
# **linksCreate**
|
|
> LinkOut linksCreate(linkCreate)
|
|
|
|
Create
|
|
|
|
Confirm a pairing the matcher missed. Never touched by the automatic rebuild afterwards.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getLinksApi();
|
|
final LinkCreate linkCreate = ; // LinkCreate |
|
|
|
|
try {
|
|
final response = api.linksCreate(linkCreate);
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling LinksApi->linksCreate: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**linkCreate** | [**LinkCreate**](LinkCreate.md)| |
|
|
|
|
### Return type
|
|
|
|
[**LinkOut**](LinkOut.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)
|
|
|
|
# **linksDelete**
|
|
> linksDelete(linkId)
|
|
|
|
Delete
|
|
|
|
Undo a link, manual or automatic. `flow_type` reverts on the next `POST /metrics/refresh`, when `classify` rebuilds it from the rules and `matching` no longer overwrites it.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getLinksApi();
|
|
final int linkId = 56; // int |
|
|
|
|
try {
|
|
api.linksDelete(linkId);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling LinksApi->linksDelete: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**linkId** | **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)
|
|
|
|
# **linksUnmatched**
|
|
> UnmatchedOut linksUnmatched()
|
|
|
|
Unmatched
|
|
|
|
Every candidate that survives matching without a link, on either side.
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getLinksApi();
|
|
|
|
try {
|
|
final response = api.linksUnmatched();
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling LinksApi->linksUnmatched: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**UnmatchedOut**](UnmatchedOut.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)
|
|
|