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

# \ArtistClaimsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_artist_claim**](ArtistClaimsApi.md#create_artist_claim) | **POST** /artistClaims | Create single artistClaim.
[**get_artist_claim**](ArtistClaimsApi.md#get_artist_claim) | **GET** /artistClaims/{id} | Get single artistClaim.
[**get_artist_claim_accepted_artists**](ArtistClaimsApi.md#get_artist_claim_accepted_artists) | **GET** /artistClaims/{id}/relationships/acceptedArtists | Get acceptedArtists relationship (\"to-many\").
[**get_artist_claim_owners**](ArtistClaimsApi.md#get_artist_claim_owners) | **GET** /artistClaims/{id}/relationships/owners | Get owners relationship (\"to-many\").
[**get_artist_claim_recommended_artists**](ArtistClaimsApi.md#get_artist_claim_recommended_artists) | **GET** /artistClaims/{id}/relationships/recommendedArtists | Get recommendedArtists relationship (\"to-many\").
[**patch_artist_claim**](ArtistClaimsApi.md#patch_artist_claim) | **PATCH** /artistClaims/{id} | Update single artistClaim.
[**update_artist_claim_accepted_artists**](ArtistClaimsApi.md#update_artist_claim_accepted_artists) | **PATCH** /artistClaims/{id}/relationships/acceptedArtists | Update acceptedArtists relationship (\"to-many\").



## create_artist_claim

> models::ArtistClaimsSingleResourceDataDocument create_artist_claim(country_code, artist_claims_create_operation_payload)
Create single artistClaim.

Creates a new artistClaim.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**country_code** | Option<**String**> | ISO 3166-1 alpha-2 country code |  |
**artist_claims_create_operation_payload** | Option<[**ArtistClaimsCreateOperationPayload**](ArtistClaimsCreateOperationPayload.md)> |  |  |

### Return type

[**models::ArtistClaimsSingleResourceDataDocument**](ArtistClaims_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)


## get_artist_claim

> models::ArtistClaimsSingleResourceDataDocument get_artist_claim(id, include)
Get single artistClaim.

Retrieves single artistClaim by id.

### Parameters


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

### Return type

[**models::ArtistClaimsSingleResourceDataDocument**](ArtistClaims_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_artist_claim_accepted_artists

> models::ArtistClaimsMultiRelationshipDataDocument get_artist_claim_accepted_artists(id, include, page_cursor)
Get acceptedArtists relationship (\"to-many\").

Retrieves acceptedArtists relationship.

### Parameters


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

### Return type

[**models::ArtistClaimsMultiRelationshipDataDocument**](ArtistClaims_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_artist_claim_owners

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

Retrieves owners relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Artist claim 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::ArtistClaimsMultiRelationshipDataDocument**](ArtistClaims_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_artist_claim_recommended_artists

> models::ArtistClaimsMultiRelationshipDataDocument get_artist_claim_recommended_artists(id, include, page_cursor)
Get recommendedArtists relationship (\"to-many\").

Retrieves recommendedArtists relationship.

### Parameters


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

### Return type

[**models::ArtistClaimsMultiRelationshipDataDocument**](ArtistClaims_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)


## patch_artist_claim

> patch_artist_claim(id, country_code, artist_claims_update_operation_payload)
Update single artistClaim.

Updates existing artistClaim.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Artist claim id | [required] |
**country_code** | Option<**String**> | ISO 3166-1 alpha-2 country code |  |
**artist_claims_update_operation_payload** | Option<[**ArtistClaimsUpdateOperationPayload**](ArtistClaimsUpdateOperationPayload.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)


## update_artist_claim_accepted_artists

> update_artist_claim_accepted_artists(id, country_code, artist_claim_accepted_artists_relationship_update_operation_payload)
Update acceptedArtists relationship (\"to-many\").

Updates acceptedArtists relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Artist claim id | [required] |
**country_code** | Option<**String**> | ISO 3166-1 alpha-2 country code |  |
**artist_claim_accepted_artists_relationship_update_operation_payload** | Option<[**ArtistClaimAcceptedArtistsRelationshipUpdateOperationPayload**](ArtistClaimAcceptedArtistsRelationshipUpdateOperationPayload.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)