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

# \UserRecommendationsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_user_recommendation**](UserRecommendationsApi.md#get_user_recommendation) | **GET** /userRecommendations/{id} | Get single userRecommendation.
[**get_user_recommendation_discovery_mixes**](UserRecommendationsApi.md#get_user_recommendation_discovery_mixes) | **GET** /userRecommendations/{id}/relationships/discoveryMixes | Get discoveryMixes relationship (\"to-many\").
[**get_user_recommendation_my_mixes**](UserRecommendationsApi.md#get_user_recommendation_my_mixes) | **GET** /userRecommendations/{id}/relationships/myMixes | Get myMixes relationship (\"to-many\").
[**get_user_recommendation_new_arrival_mixes**](UserRecommendationsApi.md#get_user_recommendation_new_arrival_mixes) | **GET** /userRecommendations/{id}/relationships/newArrivalMixes | Get newArrivalMixes relationship (\"to-many\").



## get_user_recommendation

> models::UserRecommendationsSingleResourceDataDocument get_user_recommendation(id, country_code, locale, include)
Get single userRecommendation.

Retrieves single userRecommendation by id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | User recommendations id | [required] |
**country_code** | Option<**String**> | ISO 3166-1 alpha-2 country code |  |
**locale** | Option<**String**> | BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. |  |[default to en-US]
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: discoveryMixes, myMixes, newArrivalMixes |  |

### Return type

[**models::UserRecommendationsSingleResourceDataDocument**](UserRecommendations_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_recommendation_discovery_mixes

> models::UserRecommendationsMultiRelationshipDataDocument get_user_recommendation_discovery_mixes(id, page_cursor, country_code, locale, include)
Get discoveryMixes relationship (\"to-many\").

Retrieves discoveryMixes relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | User recommendations id | [required] |
**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 |  |
**locale** | Option<**String**> | BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. |  |[default to en-US]
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: discoveryMixes |  |

### Return type

[**models::UserRecommendationsMultiRelationshipDataDocument**](UserRecommendations_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_recommendation_my_mixes

> models::UserRecommendationsMultiRelationshipDataDocument get_user_recommendation_my_mixes(id, page_cursor, country_code, locale, include)
Get myMixes relationship (\"to-many\").

Retrieves myMixes relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | User recommendations id | [required] |
**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 |  |
**locale** | Option<**String**> | BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. |  |[default to en-US]
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: myMixes |  |

### Return type

[**models::UserRecommendationsMultiRelationshipDataDocument**](UserRecommendations_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_recommendation_new_arrival_mixes

> models::UserRecommendationsMultiRelationshipDataDocument get_user_recommendation_new_arrival_mixes(id, page_cursor, country_code, locale, include)
Get newArrivalMixes relationship (\"to-many\").

Retrieves newArrivalMixes relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | User recommendations id | [required] |
**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 |  |
**locale** | Option<**String**> | BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. |  |[default to en-US]
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: newArrivalMixes |  |

### Return type

[**models::UserRecommendationsMultiRelationshipDataDocument**](UserRecommendations_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)