spotify-api-sdk 1.0.0

data/lib/spotify_web_api/controllers/albums_controller.rb

@@ -0,0 +1,295 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # AlbumsController
+  class AlbumsController < BaseController
+    # Get Spotify catalog information for a single album.
+    # @param [String] id Required parameter: Example:
+    # @param [String] market Optional parameter: Example:
+    # @return [AlbumObject] response from the API call
+    def get_an_album(id,
+                     market: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/albums/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(market, key: 'market'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AlbumObject.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+
+    # Get Spotify catalog information for multiple albums identified by their
+    # Spotify IDs.
+    # @param [String] ids Required parameter: Example:
+    # @param [String] market Optional parameter: Example:
+    # @return [ManyAlbums] response from the API call
+    def get_multiple_albums(ids,
+                            market: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/albums',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(ids, key: 'ids'))
+                   .query_param(new_parameter(market, key: 'market'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ManyAlbums.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+
+    # Get Spotify catalog information about an album’s tracks.
+    # Optional parameters can be used to limit the number of tracks returned.
+    # @param [String] id Required parameter: Example:
+    # @param [String] market Optional parameter: Example:
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [Integer] offset Optional parameter: Example:0
+    # @return [PagingSimplifiedTrackObject] response from the API call
+    def get_an_albums_tracks(id,
+                             market: nil,
+                             limit: 20,
+                             offset: 0)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/albums/{id}/tracks',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(market, key: 'market'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PagingSimplifiedTrackObject.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+
+    # Get a list of the albums saved in the current Spotify user's 'Your Music'
+    # library.
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [Integer] offset Optional parameter: Example:0
+    # @param [String] market Optional parameter: Example:
+    # @return [PagingSavedAlbumObject] response from the API call
+    def get_users_saved_albums(limit: 20,
+                               offset: 0,
+                               market: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/me/albums',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(market, key: 'market'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PagingSavedAlbumObject.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+
+    # Save one or more albums to the current user's 'Your Music' library.
+    # @param [String] ids Required parameter: Example:
+    # @param [MeAlbumsRequest] body Optional parameter: Example:
+    # @return [void] response from the API call
+    def save_albums_user(ids,
+                         body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/me/albums',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(ids, key: 'ids'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+
+    # Remove one or more albums from the current user's 'Your Music' library.
+    # @param [String] ids Required parameter: Example:
+    # @param [MeAlbumsRequest] body Optional parameter: Example:
+    # @return [void] response from the API call
+    def remove_albums_user(ids,
+                           body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/me/albums',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(ids, key: 'ids'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+
+    # Check if one or more albums is already saved in the current Spotify user's
+    # 'Your Music' library.
+    # @param [String] ids Required parameter: Example:
+    # @return [Array[TrueClass | FalseClass]] response from the API call
+    def check_users_saved_albums(ids)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/me/albums/contains',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(ids, key: 'ids'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:deserialize_primitive_types))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .is_primitive_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+
+    # Get a list of new album releases featured in Spotify (shown, for example,
+    # on a Spotify player’s “Browse” tab).
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [Integer] offset Optional parameter: Example:0
+    # @return [PagedAlbums] response from the API call
+    def get_new_releases(limit: 20,
+                         offset: 0)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/browse/new-releases',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PagedAlbums.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+  end
+end

data/lib/spotify_web_api/controllers/artists_controller.rb

@@ -0,0 +1,187 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # ArtistsController
+  class ArtistsController < BaseController
+    # Get Spotify catalog information for a single artist identified by their
+    # unique Spotify ID.
+    # @param [String] id Required parameter: Example:
+    # @return [ArtistObject] response from the API call
+    def get_an_artist(id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/artists/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ArtistObject.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+
+    # Get Spotify catalog information for several artists based on their Spotify
+    # IDs.
+    # @param [String] ids Required parameter: Example:
+    # @return [ManyArtists] response from the API call
+    def get_multiple_artists(ids)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/artists',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(ids, key: 'ids'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ManyArtists.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+
+    # Get Spotify catalog information about an artist's albums.
+    # @param [String] id Required parameter: Example:
+    # @param [String] include_groups Optional parameter: Example:
+    # @param [String] market Optional parameter: Example:
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [Integer] offset Optional parameter: Example:0
+    # @return [PagingArtistDiscographyAlbumObject] response from the API call
+    def get_an_artists_albums(id,
+                              include_groups: nil,
+                              market: nil,
+                              limit: 20,
+                              offset: 0)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/artists/{id}/albums',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(include_groups, key: 'include_groups'))
+                   .query_param(new_parameter(market, key: 'market'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PagingArtistDiscographyAlbumObject.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+
+    # Get Spotify catalog information about an artist's top tracks by country.
+    # @param [String] id Required parameter: Example:
+    # @param [String] market Optional parameter: Example:
+    # @return [ManyTracks] response from the API call
+    def get_an_artists_top_tracks(id,
+                                  market: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/artists/{id}/top-tracks',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(market, key: 'market'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ManyTracks.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+
+    # Get Spotify catalog information about artists similar to a given artist.
+    # Similarity is based on analysis of the Spotify community's listening
+    # history.
+    # @param [String] id Required parameter: Example:
+    # @return [ManyArtists] response from the API call
+    def get_an_artists_related_artists(id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/artists/{id}/related-artists',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth_2_0')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ManyArtists.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 "Bad or expired token. This can happen if the user revoked a'\
+                                  ' token or\nthe access token has expired. You should'\
+                                  ' re-authenticate the user.\n",
+                                 UnauthorizedException)
+                    .local_error('403',
+                                 "Bad OAuth request (wrong consumer key, bad nonce, expired'\
+                                  '\ntimestamp...). Unfortunately, re-authenticating the user'\
+                                  ' won't help here.\n",
+                                 ForbiddenException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+  end
+end