spotify-api-sdk 1.0.0

data/lib/spotify_web_api/controllers/audiobooks_controller.rb

@@ -0,0 +1,258 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # AudiobooksController
+  class AudiobooksController < BaseController
+    # Get Spotify catalog information for a single audiobook. Audiobooks are
+    # only available within the US, UK, Canada, Ireland, New Zealand and
+    # Australia markets.
+    # @param [String] id Required parameter: Example:
+    # @param [String] market Optional parameter: Example:
+    # @return [AudiobookObject] response from the API call
+    def get_an_audiobook(id,
+                         market: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/audiobooks/{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(AudiobookObject.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 "The request contains malformed data in path, query parameters,'\
+                                  ' or body.\n",
+                                 BadRequestException)
+                    .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('404',
+                                 "The requested resource cannot be found.\n",
+                                 NotFoundException)
+                    .local_error('429',
+                                 "The app has exceeded its rate limits.\n",
+                                 TooManyRequestsException))
+        .execute
+    end
+
+    # Get Spotify catalog information for several audiobooks identified by their
+    # Spotify IDs. Audiobooks are only available within the US, UK, Canada,
+    # Ireland, New Zealand and Australia markets.
+    # @param [String] ids Required parameter: Example:
+    # @param [String] market Optional parameter: Example:
+    # @return [ManyAudiobooks] response from the API call
+    def get_multiple_audiobooks(ids,
+                                market: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/audiobooks',
+                                     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(ManyAudiobooks.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 audiobook's chapters. Audiobooks
+    # are only available within the US, UK, Canada, Ireland, New Zealand and
+    # Australia markets.
+    # @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 [PagingSimplifiedChapterObject] response from the API call
+    def get_audiobook_chapters(id,
+                               market: nil,
+                               limit: 20,
+                               offset: 0)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/audiobooks/{id}/chapters',
+                                     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(PagingSimplifiedChapterObject.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 audiobooks saved in the current Spotify user's 'Your
+    # Music' library.
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [Integer] offset Optional parameter: Example:0
+    # @return [PagingSavedAudiobookObject] response from the API call
+    def get_users_saved_audiobooks(limit: 20,
+                                   offset: 0)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/me/audiobooks',
+                                     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(PagingSavedAudiobookObject.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 audiobooks to the current Spotify user's library.
+    # @param [String] ids Required parameter: Example:
+    # @return [void] response from the API call
+    def save_audiobooks_user(ids)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/me/audiobooks',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(ids, key: 'ids'))
+                   .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 audiobooks from the Spotify user's library.
+    # @param [String] ids Required parameter: Example:
+    # @return [void] response from the API call
+    def remove_audiobooks_user(ids)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/me/audiobooks',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(ids, key: 'ids'))
+                   .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 audiobooks are already saved in the current Spotify
+    # user's library.
+    # @param [String] ids Required parameter: Example:
+    # @return [Array[TrueClass | FalseClass]] response from the API call
+    def check_users_saved_audiobooks(ids)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/me/audiobooks/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/base_controller.rb

@@ -0,0 +1,66 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # BaseController.
+  class BaseController
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'APIMATIC 3.0'
+    end
+
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new builder for the Api Call instance.
+    # @return [ApiCall] The instance of ApiCall.
+    def new_api_call_builder
+      @api_call.new_builder
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/spotify_web_api/controllers/categories_controller.rb

@@ -0,0 +1,83 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # CategoriesController
+  class CategoriesController < BaseController
+    # Get a list of categories used to tag items in Spotify (on, for example,
+    # the Spotify player’s “Browse” tab).
+    # @param [String] locale Optional parameter: Example:
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [Integer] offset Optional parameter: Example:0
+    # @return [PagedCategories] response from the API call
+    def get_categories(locale: nil,
+                       limit: 20,
+                       offset: 0)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/browse/categories',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(locale, key: 'locale'))
+                   .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(PagedCategories.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 single category used to tag items in Spotify (on, for example, the
+    # Spotify player’s “Browse” tab).
+    # @param [String] category_id Required parameter: Example:
+    # @param [String] locale Optional parameter: Example:
+    # @return [CategoryObject] response from the API call
+    def get_a_category(category_id,
+                       locale: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/browse/categories/{category_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(category_id, key: 'category_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(locale, key: 'locale'))
+                   .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(CategoryObject.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/chapters_controller.rb

@@ -0,0 +1,82 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # ChaptersController
+  class ChaptersController < BaseController
+    # Get Spotify catalog information for a single audiobook chapter. Chapters
+    # are only available within the US, UK, Canada, Ireland, New Zealand and
+    # Australia markets.
+    # @param [String] id Required parameter: Example:
+    # @param [String] market Optional parameter: Example:
+    # @return [ChapterObject] response from the API call
+    def get_a_chapter(id,
+                      market: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/chapters/{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(ChapterObject.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 audiobook chapters identified
+    # by their Spotify IDs. Chapters are only available within the US, UK,
+    # Canada, Ireland, New Zealand and Australia markets.
+    # @param [String] ids Required parameter: Example:
+    # @param [String] market Optional parameter: Example:
+    # @return [ManyChapters] response from the API call
+    def get_several_chapters(ids,
+                             market: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/chapters',
+                                     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(ManyChapters.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