# FavoritesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addFavorite**](#addfavorite) | **POST** /api/v1/favorites/{documentId} | Add document to favorites|
|[**isFavorite**](#isfavorite) | **GET** /api/v1/favorites/{documentId}/is-favorite | Check favorite status|
|[**removeFavorite**](#removefavorite) | **DELETE** /api/v1/favorites/{documentId} | Remove document from favorites|
|[**toggleFavorite**](#togglefavorite) | **PUT** /api/v1/favorites/{documentId}/toggle | Toggle favorite status|

# **addFavorite**
> addFavorite()

Add a file or folder to the user\'s favorites

### Example

```typescript
import {
    FavoritesApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new FavoritesApi(configuration);

let documentId: string; // (default to undefined)

const { status, data } = await apiInstance.addFavorite(
    documentId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **documentId** | [**string**] |  | defaults to undefined|


### Return type

void (empty response body)

### Authorization

[keycloak_auth](../README.md#keycloak_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[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)

# **isFavorite**
> boolean isFavorite()

Check if a document is in the user\'s favorites

### Example

```typescript
import {
    FavoritesApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new FavoritesApi(configuration);

let documentId: string; // (default to undefined)

const { status, data } = await apiInstance.isFavorite(
    documentId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **documentId** | [**string**] |  | defaults to undefined|


### Return type

**boolean**

### Authorization

[keycloak_auth](../README.md#keycloak_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[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)

# **removeFavorite**
> removeFavorite()

Remove a file or folder from the user\'s favorites

### Example

```typescript
import {
    FavoritesApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new FavoritesApi(configuration);

let documentId: string; // (default to undefined)

const { status, data } = await apiInstance.removeFavorite(
    documentId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **documentId** | [**string**] |  | defaults to undefined|


### Return type

void (empty response body)

### Authorization

[keycloak_auth](../README.md#keycloak_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[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)

# **toggleFavorite**
> boolean toggleFavorite()

Toggle favorite status for a document (add if not favorited, remove if already favorited)

### Example

```typescript
import {
    FavoritesApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new FavoritesApi(configuration);

let documentId: string; // (default to undefined)

const { status, data } = await apiInstance.toggleFavorite(
    documentId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **documentId** | [**string**] |  | defaults to undefined|


### Return type

**boolean**

### Authorization

[keycloak_auth](../README.md#keycloak_auth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK |  -  |

[[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)