foxclient 6.0.2

Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application's access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

# \DeviceApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_device**](DeviceApi.md#get_device) | **GET** /devices/get | GET /devices/get - Get a single device by device_id, codename, or _id.
[**get_device_by_id**](DeviceApi.md#get_device_by_id) | **GET** /devices/{device_id} | GET /devices/{device_id} - Get device by ID (deprecated).
[**get_oems**](DeviceApi.md#get_oems) | **GET** /oems | GET /oems - Get a list of all unique OEM names.
[**list_devices**](DeviceApi.md#list_devices) | **GET** /devices | GET /devices/ - List devices with filters.



## get_device

> models::DeviceResponse get_device(device_id, codename, _id)
GET /devices/get - Get a single device by device_id, codename, or _id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**device_id** | Option<**String**> |  |  |
**codename** | Option<**String**> |  |  |
**_id** | Option<**String**> |  |  |

### Return type

[**models::DeviceResponse**](DeviceResponse.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_device_by_id

> models::DeviceResponse get_device_by_id(device_id)
GET /devices/{device_id} - Get device by ID (deprecated).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**device_id** | **String** | Device ID | [required] |

### Return type

[**models::DeviceResponse**](DeviceResponse.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_oems

> models::ListResponseString get_oems()
GET /oems - Get a list of all unique OEM names.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ListResponseString**](ListResponse_String.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_devices

> models::ListResponseShortDeviceResponse list_devices(id, _id, oem_name, codename, model_name, supported, maintainer, freezed, has_releases, skip, limit)
GET /devices/ - List devices with filters.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | Option<**String**> |  |  |
**_id** | Option<**String**> |  |  |
**oem_name** | Option<**String**> |  |  |
**codename** | Option<**String**> |  |  |
**model_name** | Option<**String**> |  |  |
**supported** | Option<**bool**> |  |  |
**maintainer** | Option<**String**> |  |  |
**freezed** | Option<**bool**> |  |  |
**has_releases** | Option<**bool**> |  |  |
**skip** | Option<**i64**> |  |  |
**limit** | Option<**i64**> |  |  |

### Return type

[**models::ListResponseShortDeviceResponse**](ListResponse_ShortDeviceResponse.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)