fin-tracker/app/packages/api_client/doc/LinksApi.md

fintracker_api.api.LinksApi

Load the API package

import 'package:fintracker_api/api.dart';

All URIs are relative to http://localhost

Method	HTTP request	Description
linksCreate	POST /api/v1/links	Create
linksDelete	DELETE /api/v1/links/{link_id}	Delete
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

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

Return type

LinkOut

Authorization

HTTPBearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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

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

HTTP request headers

• Content-Type: Not defined
• Accept: application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

linksUnmatched

UnmatchedOut linksUnmatched()

Unmatched

Every candidate that survives matching without a link, on either side.

Example

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

Authorization

HTTPBearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]