spotify-api-sdk 1.0.0

data/lib/spotify_web_api/controllers/episodes_controller.rb

@@ -0,0 +1,239 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # EpisodesController
+  class EpisodesController < BaseController
+    # Get Spotify catalog information for a single episode identified by its
+    # unique Spotify ID.
+    # @param [String] id Required parameter: Example:
+    # @param [String] market Optional parameter: Example:
+    # @return [EpisodeObject] response from the API call
+    def get_an_episode(id,
+                       market: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/episodes/{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(EpisodeObject.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 episodes based on their
+    # Spotify IDs.
+    # @param [String] ids Required parameter: Example:
+    # @param [String] market Optional parameter: Example:
+    # @return [ManyEpisodes] response from the API call
+    def get_multiple_episodes(ids,
+                              market: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/episodes',
+                                     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(ManyEpisodes.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 episodes saved in the current Spotify user's
+    # library.<br/>
+    # This API endpoint is in __beta__ and could change without warning. Please
+    # share any feedback that you have, or issues that you discover, in our
+    # [developer community
+    # forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotif
+    # y_Developer).
+    # @param [String] market Optional parameter: Example:
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [Integer] offset Optional parameter: Example:0
+    # @return [PagingSavedEpisodeObject] response from the API call
+    def get_users_saved_episodes(market: nil,
+                                 limit: 20,
+                                 offset: 0)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/me/episodes',
+                                     Server::DEFAULT)
+                   .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(PagingSavedEpisodeObject.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 episodes to the current user's library.<br/>
+    # This API endpoint is in __beta__ and could change without warning. Please
+    # share any feedback that you have, or issues that you discover, in our
+    # [developer community
+    # forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotif
+    # y_Developer).
+    # @param [String] ids Required parameter: Example:
+    # @param [MeEpisodesRequest] body Optional parameter: Example:
+    # @return [void] response from the API call
+    def save_episodes_user(ids,
+                           body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/me/episodes',
+                                     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 episodes from the current user's library.<br/>
+    # This API endpoint is in __beta__ and could change without warning. Please
+    # share any feedback that you have, or issues that you discover, in our
+    # [developer community
+    # forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotif
+    # y_Developer).
+    # @param [String] ids Required parameter: Example:
+    # @param [MeEpisodesRequest1] body Optional parameter: Example:
+    # @return [void] response from the API call
+    def remove_episodes_user(ids,
+                             body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/me/episodes',
+                                     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 episodes is already saved in the current Spotify
+    # user's 'Your Episodes' library.<br/>
+    # This API endpoint is in __beta__ and could change without warning. Please
+    # share any feedback that you have, or issues that you discover, in our
+    # [developer community
+    # forum](https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotif
+    # y_Developer)..
+    # @param [String] ids Required parameter: Example:
+    # @return [Array[TrueClass | FalseClass]] response from the API call
+    def check_users_saved_episodes(ids)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/me/episodes/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
+  end
+end

data/lib/spotify_web_api/controllers/genres_controller.rb

@@ -0,0 +1,39 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # GenresController
+  class GenresController < BaseController
+    # Retrieve a list of available genres seed parameter values for
+    # [recommendations](/documentation/web-api/reference/get-recommendations).
+    # @return [ManyGenres] response from the API call
+    def get_recommendation_genres
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/recommendations/available-genre-seeds',
+                                     Server::DEFAULT)
+                   .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(ManyGenres.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/markets_controller.rb

@@ -0,0 +1,38 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # MarketsController
+  class MarketsController < BaseController
+    # Get the list of markets where Spotify is available.
+    # @return [Markets] response from the API call
+    def get_available_markets
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/markets',
+                                     Server::DEFAULT)
+                   .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(Markets.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/o_auth_authorization_controller.rb

@@ -0,0 +1,82 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # OAuthAuthorizationController
+  class OAuthAuthorizationController < BaseController
+    # Create a new OAuth 2 token.
+    # @param [String] authorization Required parameter: Authorization header in
+    # Basic auth format
+    # @param [String] code Required parameter: Authorization Code
+    # @param [String] redirect_uri Required parameter: Redirect Uri
+    # @param [Hash] _field_parameters Additional optional form parameters are
+    # supported by this endpoint.
+    # @return [OAuthToken] response from the API call
+    def request_token(authorization,
+                      code,
+                      redirect_uri,
+                      _field_parameters: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/token',
+                                     Server::AUTH_SERVER)
+                   .form_param(new_parameter('authorization_code', key: 'grant_type'))
+                   .header_param(new_parameter(authorization, key: 'Authorization'))
+                   .form_param(new_parameter(code, key: 'code'))
+                   .form_param(new_parameter(redirect_uri, key: 'redirect_uri'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .additional_form_params(_field_parameters))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(OAuthToken.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'OAuth 2 provider returned an error.',
+                                 OAuthProviderException)
+                    .local_error('401',
+                                 'OAuth 2 provider says client authentication failed.',
+                                 OAuthProviderException))
+        .execute
+    end
+
+    # Obtain a new access token using a refresh token
+    # @param [String] authorization Required parameter: Authorization header in
+    # Basic auth format
+    # @param [String] refresh_token Required parameter: Refresh token
+    # @param [String] scope Optional parameter: Requested scopes as a
+    # space-delimited list.
+    # @param [Hash] _field_parameters Additional optional form parameters are
+    # supported by this endpoint.
+    # @return [OAuthToken] response from the API call
+    def refresh_token(authorization,
+                      refresh_token,
+                      scope: nil,
+                      _field_parameters: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/token',
+                                     Server::AUTH_SERVER)
+                   .form_param(new_parameter('refresh_token', key: 'grant_type'))
+                   .header_param(new_parameter(authorization, key: 'Authorization'))
+                   .form_param(new_parameter(refresh_token, key: 'refresh_token'))
+                   .form_param(new_parameter(scope, key: 'scope'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .additional_form_params(_field_parameters))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(OAuthToken.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'OAuth 2 provider returned an error.',
+                                 OAuthProviderException)
+                    .local_error('401',
+                                 'OAuth 2 provider says client authentication failed.',
+                                 OAuthProviderException))
+        .execute
+    end
+  end
+end