foxclient 6.0.7

# \ReleaseApi

All URIs are relative to *https://api.orangefox.download*

Method | HTTP request | Description
------------- | ------------- | -------------
[**download_release**](ReleaseApi.md#download_release) | **GET** /release/{release_id}/dl | GET /release/{release_id}/dl - Download a release binary.
[**get_release**](ReleaseApi.md#get_release) | **GET** /releases/get | GET /releases/get - Get a single release.
[**get_release_by_id**](ReleaseApi.md#get_release_by_id) | **GET** /releases/{release_id} | GET /releases/{release_id} - Get release by ID (deprecated).
[**get_updates_after**](ReleaseApi.md#get_updates_after) | **GET** /updates/{last_known_id} | GET /updates/{last_known_id} - Get releases after a given release ID (deprecated).
[**list_releases**](ReleaseApi.md#list_releases) | **GET** /releases | GET /releases/ - List releases with filters.



## download_release

> download_release(release_id)
GET /release/{release_id}/dl - Download a release binary.

The API hosts release binaries itself (acting as its own mirror). Each successful download is recorded in the `stats` collection.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**release_id** | **String** | Release ID | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/zip, application/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)


## get_release

> models::ReleaseResponse get_release(id, _id, build_id, filename)
GET /releases/get - Get a single release.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | Option<**String**> |  |  |
**_id** | Option<**String**> |  |  |
**build_id** | Option<**String**> |  |  |
**filename** | Option<**String**> |  |  |

### Return type

[**models::ReleaseResponse**](ReleaseResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/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)


## get_release_by_id

> models::ReleaseResponse get_release_by_id(release_id)
GET /releases/{release_id} - Get release by ID (deprecated).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**release_id** | **String** | Release ID | [required] |

### Return type

[**models::ReleaseResponse**](ReleaseResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/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)


## get_updates_after

> models::ListResponseReleaseResponse get_updates_after(last_known_id)
GET /updates/{last_known_id} - Get releases after a given release ID (deprecated).

Returns all non-archived releases that were created after the specified release's date.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**last_known_id** | **String** | Last known release ID | [required] |

### Return type

[**models::ListResponseReleaseResponse**](ListResponse_ReleaseResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/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)


## list_releases

> models::ReleaseListResponse list_releases(id, _id, build_id, device_id, maintainer_id, codename, version, r#type, archived, freezed, after_release_id, after_date, sort, group, skip, limit)
GET /releases/ - List releases with filters.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | Option<**String**> |  |  |
**_id** | Option<**String**> |  |  |
**build_id** | Option<**String**> |  |  |
**device_id** | Option<**String**> |  |  |
**maintainer_id** | Option<**String**> |  |  |
**codename** | Option<**String**> |  |  |
**version** | Option<**String**> |  |  |
**r#type** | Option<**String**> |  |  |
**archived** | Option<**bool**> |  |  |
**freezed** | Option<**bool**> |  |  |
**after_release_id** | Option<**String**> |  |  |
**after_date** | Option<**i64**> |  |  |
**sort** | Option<**String**> |  |  |
**group** | Option<**bool**> |  |  |
**skip** | Option<**i64**> |  |  |
**limit** | Option<**i64**> |  |  |

### Return type

[**models::ReleaseListResponse**](ReleaseListResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/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)