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

# fintracker_api.api.GoalsApi

## Load the API package
```dart
import 'package:fintracker_api/api.dart';
```

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**goalsCreate**](GoalsApi.md#goalscreate) | **POST** /api/v1/goals | Create
[**goalsDelete**](GoalsApi.md#goalsdelete) | **DELETE** /api/v1/goals/{goal_id} | Delete
[**goalsList**](GoalsApi.md#goalslist) | **GET** /api/v1/goals | List
[**goalsPatch**](GoalsApi.md#goalspatch) | **PATCH** /api/v1/goals/{goal_id} | Patch
[**goalsProgress**](GoalsApi.md#goalsprogress) | **GET** /api/v1/goals/{goal_id}/progress | Progress


# **goalsCreate**
> GoalOut goalsCreate(goalCreate)

Create

### Example
```dart
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**](GoalCreate.md)|  | 

### Return type

[**GoalOut**](GoalOut.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)

# **goalsDelete**
> goalsDelete(goalId)

Delete

### Example
```dart
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](../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)

# **goalsList**
> List<GoalOut> goalsList(includeArchived)

List

### Example
```dart
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&lt;GoalOut&gt;**](GoalOut.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)

# **goalsPatch**
> GoalOut goalsPatch(goalId, goalPatch)

Patch

### Example
```dart
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**](GoalPatch.md)|  | 

### Return type

[**GoalOut**](GoalOut.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)

# **goalsProgress**
> GoalProgressOut goalsProgress(goalId)

Progress

### Example
```dart
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**](GoalProgressOut.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)