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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

# \EpisodeApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**api_v3_episode_get**](EpisodeApi.md#api_v3_episode_get) | **GET** /api/v3/episode | 
[**api_v3_episode_id_get**](EpisodeApi.md#api_v3_episode_id_get) | **GET** /api/v3/episode/{id} | 
[**api_v3_episode_id_put**](EpisodeApi.md#api_v3_episode_id_put) | **PUT** /api/v3/episode/{id} | 
[**api_v3_episode_monitor_put**](EpisodeApi.md#api_v3_episode_monitor_put) | **PUT** /api/v3/episode/monitor | 



## api_v3_episode_get

> Vec<models::EpisodeResource> api_v3_episode_get(series_id, season_number, episode_ids, episode_file_id, include_images)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**series_id** | Option<**i32**> |  |  |
**season_number** | Option<**i32**> |  |  |
**episode_ids** | Option<[**Vec<i32>**](i32.md)> |  |  |
**episode_file_id** | Option<**i32**> |  |  |
**include_images** | Option<**bool**> |  |  |[default to false]

### Return type

[**Vec<models::EpisodeResource>**](EpisodeResource.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_episode_id_get

> models::EpisodeResource api_v3_episode_id_get(id)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** |  | [required] |

### Return type

[**models::EpisodeResource**](EpisodeResource.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_episode_id_put

> models::EpisodeResource api_v3_episode_id_put(id, episode_resource)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** |  | [required] |
**episode_resource** | Option<[**EpisodeResource**](EpisodeResource.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain, application/json, text/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_episode_monitor_put

> api_v3_episode_monitor_put(include_images, episodes_monitored_resource)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**include_images** | Option<**bool**> |  |  |[default to false]
**episodes_monitored_resource** | Option<[**EpisodesMonitoredResource**](EpisodesMonitoredResource.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
- **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)