Package org.hihn.listenbrainz
Class LbRecommendationsApi
java.lang.Object
org.hihn.listenbrainz.LbRecommendationsApi
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclass
class
class
class
class
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondeleteFeedback
(DeleteFeedbackRequest deleteFeedbackRequest) Delete feedback for a user.feedbackGivenBy
(String userName) Get feedback given by user 'user_name'.int
recordingRecommendations
(String userName) Get recommendations sorted on rating and ratings for user 'user_name'.recordingsFeedbackGivenBy
(String userName, List<UUID> mbids) Get feedback given by user 'user_name' for the list of recordings supplied.void
setApiClient
(ApiClient apiClient) void
setCustomBaseUrl
(String customBaseUrl) void
setHostIndex
(int hostIndex) submitFeedback
(SubmitFeedbackRequest submitFeedbackRequest) Submit recommendation feedback.
-
Constructor Details
-
LbRecommendationsApi
public LbRecommendationsApi() -
LbRecommendationsApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
deleteFeedback
public LbRecommendationsApi.APIdeleteFeedbackRequest deleteFeedback(DeleteFeedbackRequest deleteFeedbackRequest) Delete feedback for a user. A user token (found on https://listenbrainz.org/settings/ ) must be provided in the Authorization header! Each request should contain only one recording mbid in the payload.- Parameters:
deleteFeedbackRequest
- (required)- Returns:
- APIdeleteFeedbackRequest
- Http Response Details:
Status Code Description Response Headers 200 Feedback accepted. - 400 Invalid JSON sent. - 401 Invalid authorization. -
-
feedbackGivenBy
Get feedback given by user 'user_name'.- Parameters:
userName
- The MusicBrainz ID of the user whose timeline is being requested. (required)- Returns:
- APIfeedbackGivenByRequest
- Http Response Details:
Status Code Description Response Headers 200 Yay, you have data! - 204 Recommendations for the user haven't been generated, empty response will be returned. - 400 Bad request. - 404 User not found. -
-
recordingRecommendations
public LbRecommendationsApi.APIrecordingRecommendationsRequest recordingRecommendations(String userName) Get recommendations sorted on rating and ratings for user 'user_name'.- Parameters:
userName
- The MusicBrainz ID of the user whose timeline is being requested. (required)- Returns:
- APIrecordingRecommendationsRequest
- Http Response Details:
Status Code Description Response Headers 200 Successful query, you have data! - 204 Recommendations for the user haven't been generated, empty response will be returned. - 400 Bad request. - 404 User not found. -
-
recordingsFeedbackGivenBy
public LbRecommendationsApi.APIrecordingsFeedbackGivenByRequest recordingsFeedbackGivenBy(String userName, List<UUID> mbids) Get feedback given by user 'user_name' for the list of recordings supplied.- Parameters:
userName
- The MusicBrainz ID of the user whose timeline is being requested. (required)mbids
- Comma separated list of recording_mbids for which feedback records are to be fetched. (required)- Returns:
- APIrecordingsFeedbackGivenByRequest
- Http Response Details:
Status Code Description Response Headers 200 Yay, you have data! - 400 Bad request. - 404 User not found. -
-
submitFeedback
public LbRecommendationsApi.APIsubmitFeedbackRequest submitFeedback(SubmitFeedbackRequest submitFeedbackRequest) Submit recommendation feedback. A user token (found on https://listenbrainz.org/settings/ ) must be provided in the Authorization header! Each request should contain only one feedback in the payload.- Parameters:
submitFeedbackRequest
- (required)- Returns:
- APIsubmitFeedbackRequest
- Http Response Details:
Status Code Description Response Headers 200 Feedback accepted. - 400 Invalid JSON sent. - 401 Invalid authorization. -
-