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

fintracker_api.api.PortfoliosApi

Load the API package

import 'package:fintracker_api/api.dart';

All URIs are relative to http://localhost

Method	HTTP request	Description
portfoliosCreate	POST /api/v1/portfolios	Create
portfoliosDelete	DELETE /api/v1/portfolios/{portfolio_id}	Delete
portfoliosList	GET /api/v1/portfolios	List
portfoliosPatch	PATCH /api/v1/portfolios/{portfolio_id}	Patch
portfoliosSetAccounts	PUT /api/v1/portfolios/{portfolio_id}/accounts	Set Accounts

portfoliosCreate

PortfolioOut portfoliosCreate(portfolioCreate)

Create

Example

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

Return type

PortfolioOut

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]

portfoliosDelete

portfoliosDelete(portfolioId)

Delete

Example

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

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]

portfoliosList

List portfoliosList()

List

Example

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>

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]

portfoliosPatch

PortfolioOut portfoliosPatch(portfolioId, portfolioPatch)

Patch

Example

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

Return type

PortfolioOut

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]

portfoliosSetAccounts

PortfolioOut portfoliosSetAccounts(portfolioId, portfolioAccountsIn)

Set Accounts

Example

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

Return type

PortfolioOut

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]