prawn 0.1.0

Rust Client for the Tidal API providing comprehensive API coverag, and easy OAuth management
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251

# \SearchResultsApi

All URIs are relative to *https://openapi.tidal.com/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_search_result**](SearchResultsApi.md#get_search_result) | **GET** /searchResults/{id} | Get single searchResult.
[**get_search_result_albums**](SearchResultsApi.md#get_search_result_albums) | **GET** /searchResults/{id}/relationships/albums | Get albums relationship (\"to-many\").
[**get_search_result_artists**](SearchResultsApi.md#get_search_result_artists) | **GET** /searchResults/{id}/relationships/artists | Get artists relationship (\"to-many\").
[**get_search_result_playlists**](SearchResultsApi.md#get_search_result_playlists) | **GET** /searchResults/{id}/relationships/playlists | Get playlists relationship (\"to-many\").
[**get_search_result_tracks**](SearchResultsApi.md#get_search_result_tracks) | **GET** /searchResults/{id}/relationships/tracks | Get tracks relationship (\"to-many\").
[**get_search_result_videos**](SearchResultsApi.md#get_search_result_videos) | **GET** /searchResults/{id}/relationships/videos | Get videos relationship (\"to-many\").
[**get_search_results_top_hits**](SearchResultsApi.md#get_search_results_top_hits) | **GET** /searchResults/{id}/relationships/topHits | Get topHits relationship (\"to-many\").



## get_search_result

> models::SearchResultsSingleResourceDataDocument get_search_result(id, explicit_filter, country_code, include)
Get single searchResult.

Retrieves single searchResult by id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Search query string used as the resource identifier | [required] |
**explicit_filter** | Option<**String**> | Explicit filter |  |[default to INCLUDE]
**country_code** | Option<**String**> | ISO 3166-1 alpha-2 country code |  |
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: albums, artists, playlists, topHits, tracks, videos |  |

### Return type

[**models::SearchResultsSingleResourceDataDocument**](SearchResults_Single_Resource_Data_Document.md)

### Authorization

[Authorization_Code_PKCE](../README.md#Authorization_Code_PKCE), [Client_Credentials](../README.md#Client_Credentials)

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

> models::SearchResultsMultiRelationshipDataDocument get_search_result_albums(id, explicit_filter, page_cursor, country_code, include)
Get albums relationship (\"to-many\").

Retrieves albums relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Search query string used as the resource identifier | [required] |
**explicit_filter** | Option<**String**> | Explicit filter |  |[default to INCLUDE]
**page_cursor** | Option<**String**> | Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified |  |
**country_code** | Option<**String**> | ISO 3166-1 alpha-2 country code |  |
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: albums |  |

### Return type

[**models::SearchResultsMultiRelationshipDataDocument**](SearchResults_Multi_Relationship_Data_Document.md)

### Authorization

[Authorization_Code_PKCE](../README.md#Authorization_Code_PKCE), [Client_Credentials](../README.md#Client_Credentials)

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

> models::SearchResultsMultiRelationshipDataDocument get_search_result_artists(id, explicit_filter, page_cursor, country_code, include)
Get artists relationship (\"to-many\").

Retrieves artists relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Search query string used as the resource identifier | [required] |
**explicit_filter** | Option<**String**> | Explicit filter |  |[default to INCLUDE]
**page_cursor** | Option<**String**> | Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified |  |
**country_code** | Option<**String**> | ISO 3166-1 alpha-2 country code |  |
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: artists |  |

### Return type

[**models::SearchResultsMultiRelationshipDataDocument**](SearchResults_Multi_Relationship_Data_Document.md)

### Authorization

[Authorization_Code_PKCE](../README.md#Authorization_Code_PKCE), [Client_Credentials](../README.md#Client_Credentials)

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

> models::SearchResultsMultiRelationshipDataDocument get_search_result_playlists(id, explicit_filter, page_cursor, country_code, include)
Get playlists relationship (\"to-many\").

Retrieves playlists relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Search query string used as the resource identifier | [required] |
**explicit_filter** | Option<**String**> | Explicit filter |  |[default to INCLUDE]
**page_cursor** | Option<**String**> | Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified |  |
**country_code** | Option<**String**> | ISO 3166-1 alpha-2 country code |  |
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: playlists |  |

### Return type

[**models::SearchResultsMultiRelationshipDataDocument**](SearchResults_Multi_Relationship_Data_Document.md)

### Authorization

[Authorization_Code_PKCE](../README.md#Authorization_Code_PKCE), [Client_Credentials](../README.md#Client_Credentials)

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

> models::SearchResultsMultiRelationshipDataDocument get_search_result_tracks(id, explicit_filter, page_cursor, country_code, include)
Get tracks relationship (\"to-many\").

Retrieves tracks relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Search query string used as the resource identifier | [required] |
**explicit_filter** | Option<**String**> | Explicit filter |  |[default to INCLUDE]
**page_cursor** | Option<**String**> | Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified |  |
**country_code** | Option<**String**> | ISO 3166-1 alpha-2 country code |  |
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: tracks |  |

### Return type

[**models::SearchResultsMultiRelationshipDataDocument**](SearchResults_Multi_Relationship_Data_Document.md)

### Authorization

[Authorization_Code_PKCE](../README.md#Authorization_Code_PKCE), [Client_Credentials](../README.md#Client_Credentials)

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

> models::SearchResultsMultiRelationshipDataDocument get_search_result_videos(id, explicit_filter, page_cursor, country_code, include)
Get videos relationship (\"to-many\").

Retrieves videos relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Search query string used as the resource identifier | [required] |
**explicit_filter** | Option<**String**> | Explicit filter |  |[default to INCLUDE]
**page_cursor** | Option<**String**> | Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified |  |
**country_code** | Option<**String**> | ISO 3166-1 alpha-2 country code |  |
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: videos |  |

### Return type

[**models::SearchResultsMultiRelationshipDataDocument**](SearchResults_Multi_Relationship_Data_Document.md)

### Authorization

[Authorization_Code_PKCE](../README.md#Authorization_Code_PKCE), [Client_Credentials](../README.md#Client_Credentials)

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

> models::SearchResultsMultiRelationshipDataDocument get_search_results_top_hits(id, explicit_filter, page_cursor, country_code, include)
Get topHits relationship (\"to-many\").

Retrieves topHits relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Search query string used as the resource identifier | [required] |
**explicit_filter** | Option<**String**> | Explicit filter |  |[default to INCLUDE]
**page_cursor** | Option<**String**> | Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified |  |
**country_code** | Option<**String**> | ISO 3166-1 alpha-2 country code |  |
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: topHits |  |

### Return type

[**models::SearchResultsMultiRelationshipDataDocument**](SearchResults_Multi_Relationship_Data_Document.md)

### Authorization

[Authorization_Code_PKCE](../README.md#Authorization_Code_PKCE), [Client_Credentials](../README.md#Client_Credentials)

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