Update to fixed-spotify-open-api.yml (#147)

Author: sonallux

spotify-web-api-java-generator/fixed-spotify-open-api.yml

@@ -11,7 +11,9 @@ public class SpotifyWebApi  {
 
     private final AlbumsApi albumsApi;
     private final ArtistsApi artistsApi;
+    private final AudiobooksApi audiobooksApi;
     private final BrowseApi browseApi;
+    private final ChaptersApi chaptersApi;
     private final EpisodesApi episodesApi;
     private final FollowApi followApi;
     private final LibraryApi libraryApi;
@@ -27,7 +29,9 @@ public class SpotifyWebApi  {
     SpotifyWebApi(ApiClient apiClient) {
         this.albumsApi = new AlbumsApi(apiClient);
         this.artistsApi = new ArtistsApi(apiClient);
+        this.audiobooksApi = new AudiobooksApi(apiClient);
         this.browseApi = new BrowseApi(apiClient);
+        this.chaptersApi = new ChaptersApi(apiClient);
         this.episodesApi = new EpisodesApi(apiClient);
         this.followApi = new FollowApi(apiClient);
         this.libraryApi = new LibraryApi(apiClient);

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/SpotifyWebApi.java

@@ -0,0 +1,33 @@
+package de.sonallux.spotify.api.apis;
+
+import de.sonallux.spotify.api.http.ApiClient;
+import de.sonallux.spotify.api.apis.audiobooks.*;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * Audiobooks
+ */
+@RequiredArgsConstructor
+public class AudiobooksApi {
+    private final ApiClient apiClient;
+
+    /**
+     * <h4>Get an Audiobook</h4>
+     * <p>Get Spotify catalog information for a single audiobook.<br><strong>Note: Audiobooks are only available for the US market.</strong></p>
+     * @param id <p>The <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify ID</a>for the audiobook.</p>
+     * @return a {@link GetAudiobookRequest} object to build and execute the request
+     */
+    public GetAudiobookRequest getAudiobook(String id) {
+        return new GetAudiobookRequest(apiClient, id);
+    }
+
+    /**
+     * <h4>Get Several Audiobooks</h4>
+     * <p>Get Spotify catalog information for several audiobooks identified by their Spotify IDs.<br><strong>Note: Audiobooks are only available for the US market.</strong></p>
+     * @param ids <p>A comma-separated list of the <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify IDs</a>. For example: <code>ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M</code>. Maximum: 50 IDs.</p>
+     * @return a {@link GetMultipleAudiobooksRequest} object to build and execute the request
+     */
+    public GetMultipleAudiobooksRequest getMultipleAudiobooks(String ids) {
+        return new GetMultipleAudiobooksRequest(apiClient, ids);
+    }
+}

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/AudiobooksApi.java

@@ -0,0 +1,33 @@
+package de.sonallux.spotify.api.apis;
+
+import de.sonallux.spotify.api.http.ApiClient;
+import de.sonallux.spotify.api.apis.chapters.*;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * Chapters
+ */
+@RequiredArgsConstructor
+public class ChaptersApi {
+    private final ApiClient apiClient;
+
+    /**
+     * <h4>Get a Chapter</h4>
+     * <p>Get Spotify catalog information for a single chapter.<br><strong>Note: Chapters are only available for the US market.</strong></p>
+     * @param id <p>The <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify ID</a>for the chapter.</p>
+     * @return a {@link GetChapterRequest} object to build and execute the request
+     */
+    public GetChapterRequest getChapter(String id) {
+        return new GetChapterRequest(apiClient, id);
+    }
+
+    /**
+     * <h4>Get Several Chapters</h4>
+     * <p>Get Spotify catalog information for several chapters identified by their Spotify IDs.<br><strong>Note: Chapters are only available for the US market.</strong></p>
+     * @param ids <p>A comma-separated list of the <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify IDs</a>. For example: <code>ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M</code>. Maximum: 50 IDs.</p>
+     * @return a {@link GetSeveralChaptersRequest} object to build and execute the request
+     */
+    public GetSeveralChaptersRequest getSeveralChapters(String ids) {
+        return new GetSeveralChaptersRequest(apiClient, ids);
+    }
+}

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/ChaptersApi.java

@@ -13,7 +13,7 @@ public class SearchApi {
 
     /**
      * <h4>Search for Item</h4>
-     * <p>Get Spotify catalog information about albums, artists, playlists, tracks, shows or episodes that match a keyword string.</p>
+     * <p>Get Spotify catalog information about albums, artists, playlists, tracks, shows, episodes or audiobooks that match a keyword string.<br><strong>Note: Audiobooks are only available for the US market.</strong></p>
      * @param q <p>Your search query.</p><p>You can narrow down your search using field filters. The available filters are <code>album</code>, <code>artist</code>, <code>track</code>, <code>year</code>, <code>upc</code>, <code>tag:hipster</code>, <code>tag:new</code>, <code>isrc</code>, and <code>genre</code>. Each field filter only applies to certain result types.</p><p>The <code>artist</code> and <code>year</code> filters can be used while searching albums, artists and tracks. You can filter on a single <code>year</code> or a range (e.g. 1955-1960).<br>The <code>album</code> filter can be used while searching albums and tracks.<br>The <code>genre</code> filter can be used while searching artists and tracks.<br>The <code>isrc</code> and <code>track</code> filters can be used while searching tracks.<br>The <code>upc</code>, <code>tag:new</code> and <code>tag:hipster</code> filters can only be used while searching albums. The <code>tag:new</code> filter will return albums released in the past two weeks and <code>tag:hipster</code> can be used to return only albums with the lowest 10% popularity.<br></p>
      * @param type <p>A comma-separated list of item types to search across. Search results include hits from all the specified item types. For example: <code>q=abacab&amp;type=album,track</code> returns both albums and tracks matching &quot;abacab&quot;.</p>
      * @return a {@link SearchRequest} object to build and execute the request

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/SearchApi.java

@@ -0,0 +1,48 @@
+package de.sonallux.spotify.api.apis.audiobooks;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import de.sonallux.spotify.api.http.ApiCall;
+import de.sonallux.spotify.api.http.ApiClient;
+import de.sonallux.spotify.api.http.Request;
+import de.sonallux.spotify.api.models.*;
+
+/**
+ * <h2>Get an Audiobook request</h2>
+ *
+ * <h3>Response</h3>
+ * <p>An Audiobook</p>
+ */
+public class GetAudiobookRequest {
+    private static final TypeReference<Audiobook> RESPONSE_TYPE = new TypeReference<>() {};
+    private final ApiClient apiClient;
+    private final Request request;
+
+    /**
+     * Get an Audiobook request
+     * @param apiClient <p>The API client</p>
+     * @param id <p>The <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify ID</a>for the audiobook.</p>
+     */
+    public GetAudiobookRequest(ApiClient apiClient, String id) {
+        this.apiClient = apiClient;
+        this.request = new Request("GET", "/audiobooks/{id}")
+            .addPathParameter("id", String.valueOf(id))
+        ;
+    }
+
+    /**
+     * @param market <p>An <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2 country code</a>. If a country code is specified, only content that is available in that market will be returned.<br>If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.<br><em><strong>Note</strong>: If neither market or user country are provided, the content is considered unavailable for the client.</em><br>Users can view the country that is associated with their account in the <a href="https://www.spotify.com/se/account/overview/">account settings</a>.</p>
+     * @return this request
+     */
+    public GetAudiobookRequest market(String market) {
+        this.request.addQueryParameter("market", String.valueOf(market));
+        return this;
+    }
+
+    /**
+     * Build the request into an executable api call
+     * @return an executable api call
+     */
+    public ApiCall<Audiobook> build() {
+        return apiClient.createApiCall(request, RESPONSE_TYPE);
+    }
+}

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/audiobooks/GetAudiobookRequest.java

@@ -0,0 +1,48 @@
+package de.sonallux.spotify.api.apis.audiobooks;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import de.sonallux.spotify.api.http.ApiCall;
+import de.sonallux.spotify.api.http.ApiClient;
+import de.sonallux.spotify.api.http.Request;
+import de.sonallux.spotify.api.models.*;
+
+/**
+ * <h2>Get Several Audiobooks request</h2>
+ *
+ * <h3>Response</h3>
+ * <p>A set of audiobooks</p>
+ */
+public class GetMultipleAudiobooksRequest {
+    private static final TypeReference<ManyAudiobooks> RESPONSE_TYPE = new TypeReference<>() {};
+    private final ApiClient apiClient;
+    private final Request request;
+
+    /**
+     * Get Several Audiobooks request
+     * @param apiClient <p>The API client</p>
+     * @param ids <p>A comma-separated list of the <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify IDs</a>. For example: <code>ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M</code>. Maximum: 50 IDs.</p>
+     */
+    public GetMultipleAudiobooksRequest(ApiClient apiClient, String ids) {
+        this.apiClient = apiClient;
+        this.request = new Request("GET", "/audiobooks")
+            .addQueryParameter("ids", String.valueOf(ids))
+        ;
+    }
+
+    /**
+     * @param market <p>An <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2 country code</a>. If a country code is specified, only content that is available in that market will be returned.<br>If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.<br><em><strong>Note</strong>: If neither market or user country are provided, the content is considered unavailable for the client.</em><br>Users can view the country that is associated with their account in the <a href="https://www.spotify.com/se/account/overview/">account settings</a>.</p>
+     * @return this request
+     */
+    public GetMultipleAudiobooksRequest market(String market) {
+        this.request.addQueryParameter("market", String.valueOf(market));
+        return this;
+    }
+
+    /**
+     * Build the request into an executable api call
+     * @return an executable api call
+     */
+    public ApiCall<ManyAudiobooks> build() {
+        return apiClient.createApiCall(request, RESPONSE_TYPE);
+    }
+}

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/audiobooks/GetMultipleAudiobooksRequest.java

@@ -0,0 +1,48 @@
+package de.sonallux.spotify.api.apis.chapters;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import de.sonallux.spotify.api.http.ApiCall;
+import de.sonallux.spotify.api.http.ApiClient;
+import de.sonallux.spotify.api.http.Request;
+import de.sonallux.spotify.api.models.*;
+
+/**
+ * <h2>Get a Chapter request</h2>
+ *
+ * <h3>Response</h3>
+ * <p>A Chapter</p>
+ */
+public class GetChapterRequest {
+    private static final TypeReference<Chapter> RESPONSE_TYPE = new TypeReference<>() {};
+    private final ApiClient apiClient;
+    private final Request request;
+
+    /**
+     * Get a Chapter request
+     * @param apiClient <p>The API client</p>
+     * @param id <p>The <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify ID</a>for the chapter.</p>
+     */
+    public GetChapterRequest(ApiClient apiClient, String id) {
+        this.apiClient = apiClient;
+        this.request = new Request("GET", "/chapters/{id}")
+            .addPathParameter("id", String.valueOf(id))
+        ;
+    }
+
+    /**
+     * @param market <p>An <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2 country code</a>. If a country code is specified, only content that is available in that market will be returned.<br>If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.<br><em><strong>Note</strong>: If neither market or user country are provided, the content is considered unavailable for the client.</em><br>Users can view the country that is associated with their account in the <a href="https://www.spotify.com/se/account/overview/">account settings</a>.</p>
+     * @return this request
+     */
+    public GetChapterRequest market(String market) {
+        this.request.addQueryParameter("market", String.valueOf(market));
+        return this;
+    }
+
+    /**
+     * Build the request into an executable api call
+     * @return an executable api call
+     */
+    public ApiCall<Chapter> build() {
+        return apiClient.createApiCall(request, RESPONSE_TYPE);
+    }
+}

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/chapters/GetChapterRequest.java

@@ -0,0 +1,48 @@
+package de.sonallux.spotify.api.apis.chapters;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import de.sonallux.spotify.api.http.ApiCall;
+import de.sonallux.spotify.api.http.ApiClient;
+import de.sonallux.spotify.api.http.Request;
+import de.sonallux.spotify.api.models.*;
+
+/**
+ * <h2>Get Several Chapters request</h2>
+ *
+ * <h3>Response</h3>
+ * <p>A set of chapters</p>
+ */
+public class GetSeveralChaptersRequest {
+    private static final TypeReference<ManyChapters> RESPONSE_TYPE = new TypeReference<>() {};
+    private final ApiClient apiClient;
+    private final Request request;
+
+    /**
+     * Get Several Chapters request
+     * @param apiClient <p>The API client</p>
+     * @param ids <p>A comma-separated list of the <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify IDs</a>. For example: <code>ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M</code>. Maximum: 50 IDs.</p>
+     */
+    public GetSeveralChaptersRequest(ApiClient apiClient, String ids) {
+        this.apiClient = apiClient;
+        this.request = new Request("GET", "/chapters")
+            .addQueryParameter("ids", String.valueOf(ids))
+        ;
+    }
+
+    /**
+     * @param market <p>An <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2 country code</a>. If a country code is specified, only content that is available in that market will be returned.<br>If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.<br><em><strong>Note</strong>: If neither market or user country are provided, the content is considered unavailable for the client.</em><br>Users can view the country that is associated with their account in the <a href="https://www.spotify.com/se/account/overview/">account settings</a>.</p>
+     * @return this request
+     */
+    public GetSeveralChaptersRequest market(String market) {
+        this.request.addQueryParameter("market", String.valueOf(market));
+        return this;
+    }
+
+    /**
+     * Build the request into an executable api call
+     * @return an executable api call
+     */
+    public ApiCall<ManyChapters> build() {
+        return apiClient.createApiCall(request, RESPONSE_TYPE);
+    }
+}

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/chapters/GetSeveralChaptersRequest.java

@@ -0,0 +1,16 @@
+package de.sonallux.spotify.api.models;
+
+import lombok.*;
+
+/**
+ * AudiobookObject
+ */
+@Getter
+@Setter
+@NoArgsConstructor
+public class Audiobook extends AudiobookBase {
+    /**
+     * <p>The chapters of the audiobook.</p>
+     */
+    public Paging<SimplifiedChapter> chapters;
+}