sonarr-api-rs 3.0.0

Rust API wrapper for Sonarr
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

# \QueueApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**api_v3_queue_bulk_delete**](QueueApi.md#api_v3_queue_bulk_delete) | **DELETE** /api/v3/queue/bulk | 
[**api_v3_queue_get**](QueueApi.md#api_v3_queue_get) | **GET** /api/v3/queue | 
[**api_v3_queue_id_delete**](QueueApi.md#api_v3_queue_id_delete) | **DELETE** /api/v3/queue/{id} | 



## api_v3_queue_bulk_delete

> api_v3_queue_bulk_delete(remove_from_client, blocklist, skip_redownload, change_category, queue_bulk_resource)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**remove_from_client** | Option<**bool**> |  |  |[default to true]
**blocklist** | Option<**bool**> |  |  |[default to false]
**skip_redownload** | Option<**bool**> |  |  |[default to false]
**change_category** | Option<**bool**> |  |  |[default to false]
**queue_bulk_resource** | Option<[**QueueBulkResource**](QueueBulkResource.md)> |  |  |

### Return type

 (empty response body)

### Authorization

[apikey](../README.md#apikey), [X-Api-Key](../README.md#X-Api-Key)

### HTTP request headers

- **Content-Type**: application/json, text/json, application/*+json
- **Accept**: Not defined

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


## api_v3_queue_get

> models::QueueResourcePagingResource api_v3_queue_get(page, page_size, sort_key, sort_direction, include_unknown_series_items, include_series, include_episode, series_ids, protocol, languages, quality)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> |  |  |[default to 1]
**page_size** | Option<**i32**> |  |  |[default to 10]
**sort_key** | Option<**String**> |  |  |
**sort_direction** | Option<[**SortDirection**](.md)> |  |  |
**include_unknown_series_items** | Option<**bool**> |  |  |[default to false]
**include_series** | Option<**bool**> |  |  |[default to false]
**include_episode** | Option<**bool**> |  |  |[default to false]
**series_ids** | Option<[**Vec<i32>**](i32.md)> |  |  |
**protocol** | Option<[**DownloadProtocol**](.md)> |  |  |
**languages** | Option<[**Vec<i32>**](i32.md)> |  |  |
**quality** | Option<**i32**> |  |  |

### Return type

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

### Authorization

[apikey](../README.md#apikey), [X-Api-Key](../README.md#X-Api-Key)

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


## api_v3_queue_id_delete

> api_v3_queue_id_delete(id, remove_from_client, blocklist, skip_redownload, change_category)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** |  | [required] |
**remove_from_client** | Option<**bool**> |  |  |[default to true]
**blocklist** | Option<**bool**> |  |  |[default to false]
**skip_redownload** | Option<**bool**> |  |  |[default to false]
**change_category** | Option<**bool**> |  |  |[default to false]

### Return type

 (empty response body)

### Authorization

[apikey](../README.md#apikey), [X-Api-Key](../README.md#X-Api-Key)

### HTTP request headers

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

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