prawn 0.0.3

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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296

# \UserCollectionFoldersApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_user_collection_folder_items**](UserCollectionFoldersApi.md#add_user_collection_folder_items) | **POST** /userCollectionFolders/{id}/relationships/items | Add to items relationship (\"to-many\").
[**create_user_collection_folder**](UserCollectionFoldersApi.md#create_user_collection_folder) | **POST** /userCollectionFolders | Create single userCollectionFolder.
[**delete_user_collection_folder**](UserCollectionFoldersApi.md#delete_user_collection_folder) | **DELETE** /userCollectionFolders/{id} | Delete single userCollectionFolder.
[**delete_user_collection_folder_items**](UserCollectionFoldersApi.md#delete_user_collection_folder_items) | **DELETE** /userCollectionFolders/{id}/relationships/items | Delete from items relationship (\"to-many\").
[**get_user_collection_folder**](UserCollectionFoldersApi.md#get_user_collection_folder) | **GET** /userCollectionFolders/{id} | Get single userCollectionFolder.
[**get_user_collection_folder_items**](UserCollectionFoldersApi.md#get_user_collection_folder_items) | **GET** /userCollectionFolders/{id}/relationships/items | Get items relationship (\"to-many\").
[**get_user_collection_folder_owners**](UserCollectionFoldersApi.md#get_user_collection_folder_owners) | **GET** /userCollectionFolders/{id}/relationships/owners | Get owners relationship (\"to-many\").
[**get_user_collection_folders**](UserCollectionFoldersApi.md#get_user_collection_folders) | **GET** /userCollectionFolders | Get multiple userCollectionFolders.
[**patch_user_collection_folder**](UserCollectionFoldersApi.md#patch_user_collection_folder) | **PATCH** /userCollectionFolders/{id} | Update single userCollectionFolder.



## add_user_collection_folder_items

> add_user_collection_folder_items(id, add_payload)
Add to items relationship (\"to-many\").

Adds item(s) to items relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Folder Id | [required] |
**add_payload** | Option<[**AddPayload**](AddPayload.md)> |  |  |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)


## create_user_collection_folder

> models::UserCollectionFoldersSingleResourceDataDocument create_user_collection_folder(folder_create_operation_payload)
Create single userCollectionFolder.

Creates a new userCollectionFolder.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**folder_create_operation_payload** | Option<[**FolderCreateOperationPayload**](FolderCreateOperationPayload.md)> |  |  |

### Return type

[**models::UserCollectionFoldersSingleResourceDataDocument**](UserCollectionFolders_Single_Resource_Data_Document.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)


## delete_user_collection_folder

> delete_user_collection_folder(id)
Delete single userCollectionFolder.

Deletes existing userCollectionFolder.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Folder Id | [required] |

### Return type

 (empty response body)

### Authorization

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

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


## delete_user_collection_folder_items

> delete_user_collection_folder_items(id, remove_payload)
Delete from items relationship (\"to-many\").

Deletes item(s) from items relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Folder Id | [required] |
**remove_payload** | Option<[**RemovePayload**](RemovePayload.md)> |  |  |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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_user_collection_folder

> models::UserCollectionFoldersSingleResourceDataDocument get_user_collection_folder(id, include)
Get single userCollectionFolder.

Retrieves single userCollectionFolder by id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Folder Id | [required] |
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: items, owners |  |

### Return type

[**models::UserCollectionFoldersSingleResourceDataDocument**](UserCollectionFolders_Single_Resource_Data_Document.md)

### Authorization

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

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

> models::UserCollectionFoldersItemsMultiRelationshipDataDocument get_user_collection_folder_items(id, page_cursor, sort, include)
Get items relationship (\"to-many\").

Retrieves items relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Folder Id | [required] |
**page_cursor** | Option<**String**> | Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified |  |
**sort** | Option<[**Vec<String>**](String.md)> | Values prefixed with \"-\" are sorted descending; values without it are sorted ascending. |  |
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: items |  |

### Return type

[**models::UserCollectionFoldersItemsMultiRelationshipDataDocument**](UserCollectionFolders_Items_Multi_Relationship_Data_Document.md)

### Authorization

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

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

> models::UserCollectionFoldersMultiRelationshipDataDocument get_user_collection_folder_owners(id, include, page_cursor)
Get owners relationship (\"to-many\").

Retrieves owners relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Folder Id | [required] |
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: owners |  |
**page_cursor** | Option<**String**> | Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified |  |

### Return type

[**models::UserCollectionFoldersMultiRelationshipDataDocument**](UserCollectionFolders_Multi_Relationship_Data_Document.md)

### Authorization

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

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

> models::UserCollectionFoldersMultiResourceDataDocument get_user_collection_folders(include, filter_left_square_bracket_id_right_square_bracket)
Get multiple userCollectionFolders.

Retrieves multiple userCollectionFolders by available filters, or without if applicable.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: items, owners |  |
**filter_left_square_bracket_id_right_square_bracket** | Option<[**Vec<String>**](String.md)> | Folder Id |  |

### Return type

[**models::UserCollectionFoldersMultiResourceDataDocument**](UserCollectionFolders_Multi_Resource_Data_Document.md)

### Authorization

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

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


## patch_user_collection_folder

> patch_user_collection_folder(id, folder_update_operation_payload)
Update single userCollectionFolder.

Updates existing userCollectionFolder.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Folder Id | [required] |
**folder_update_operation_payload** | Option<[**FolderUpdateOperationPayload**](FolderUpdateOperationPayload.md)> |  |  |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)