Dmitry
90ba198c2a
openapi-generator-cli -g dart-dio. Генерируется, но коммитится: CI ловит дрейф openapi/openapi.json, а приложение собирается без запуска генератора. Пересобирается через just gen-client после любого изменения роутов.
74 lines
2.3 KiB
Markdown
74 lines
2.3 KiB
Markdown
# 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)
|
|
|