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

fintracker_api.api.GoalsApi

Load the API package

import 'package:fintracker_api/api.dart';

All URIs are relative to http://localhost

Method	HTTP request	Description
goalsCreate	POST /api/v1/goals	Create
goalsDelete	DELETE /api/v1/goals/{goal_id}	Delete
goalsList	GET /api/v1/goals	List
goalsPatch	PATCH /api/v1/goals/{goal_id}	Patch
goalsProgress	GET /api/v1/goals/{goal_id}/progress	Progress

goalsCreate

GoalOut goalsCreate(goalCreate)

Create

Example

import 'package:fintracker_api/api.dart';

final api = FintrackerApi().getGoalsApi();
final GoalCreate goalCreate = ; // GoalCreate | 

try {
    final response = api.goalsCreate(goalCreate);
    print(response);
} on DioException catch (e) {
    print('Exception when calling GoalsApi->goalsCreate: $e\n');
}

Parameters

Name	Type	Description	Notes
goalCreate	GoalCreate

Return type

GoalOut

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]

goalsDelete

goalsDelete(goalId)

Delete

Example

import 'package:fintracker_api/api.dart';

final api = FintrackerApi().getGoalsApi();
final int goalId = 56; // int | 

try {
    api.goalsDelete(goalId);
} on DioException catch (e) {
    print('Exception when calling GoalsApi->goalsDelete: $e\n');
}

Parameters

Name	Type	Description	Notes
goalId	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]

goalsList

List goalsList(includeArchived)

List

Example

import 'package:fintracker_api/api.dart';

final api = FintrackerApi().getGoalsApi();
final bool includeArchived = true; // bool | 

try {
    final response = api.goalsList(includeArchived);
    print(response);
} on DioException catch (e) {
    print('Exception when calling GoalsApi->goalsList: $e\n');
}

Parameters

Name	Type	Description	Notes
includeArchived	bool		[optional] [default to false]

Return type

List<GoalOut>

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]

goalsPatch

GoalOut goalsPatch(goalId, goalPatch)

Patch

Example

import 'package:fintracker_api/api.dart';

final api = FintrackerApi().getGoalsApi();
final int goalId = 56; // int | 
final GoalPatch goalPatch = ; // GoalPatch | 

try {
    final response = api.goalsPatch(goalId, goalPatch);
    print(response);
} on DioException catch (e) {
    print('Exception when calling GoalsApi->goalsPatch: $e\n');
}

Parameters

Name	Type	Description	Notes
goalId	int
goalPatch	GoalPatch

Return type

GoalOut

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]

goalsProgress

GoalProgressOut goalsProgress(goalId)

Progress

Example

import 'package:fintracker_api/api.dart';

final api = FintrackerApi().getGoalsApi();
final int goalId = 56; // int | 

try {
    final response = api.goalsProgress(goalId);
    print(response);
} on DioException catch (e) {
    print('Exception when calling GoalsApi->goalsProgress: $e\n');
}

Parameters

Name	Type	Description	Notes
goalId	int

Return type

GoalProgressOut

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]