spotify-apimatic-sdk 1.0.0

data/lib/spotify_web_api/controllers/users_controller.rb

@@ -0,0 +1,402 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # UsersController
+  class UsersController < BaseController
+    # Get detailed profile information about the current user (including the
+    # current user's username).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_current_users_profile
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/me',
+                                     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(PrivateUserObject.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 public profile information about a Spotify user.
+    # @param [String] user_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_users_profile(user_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_id, key: 'user_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(PublicUserObject.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
+
+    # Add the current user as a follower of a playlist.
+    # @param [String] playlist_id Required parameter: TODO: type description
+    # here
+    # @param [PlaylistsFollowersRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def follow_playlist(playlist_id,
+                        body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/playlists/{playlist_id}/followers',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(playlist_id, key: 'playlist_id')
+                                    .should_encode(true))
+                   .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 the current user as a follower of a playlist.
+    # @param [String] playlist_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def unfollow_playlist(playlist_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/playlists/{playlist_id}/followers',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(playlist_id, key: 'playlist_id')
+                                    .should_encode(true))
+                   .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
+
+    # Get the current user's followed artists.
+    # @param [ItemType1Enum] type Required parameter: Example:
+    # @param [String] after Optional parameter: TODO: type description here
+    # @param [Integer] limit Optional parameter: Example:20
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_followed(type,
+                     after: nil,
+                     limit: 20)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/me/following',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(type, key: 'type'))
+                   .query_param(new_parameter(after, key: 'after'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .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(CursorPagedArtists.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
+
+    # Add the current user as a follower of one or more artists or other Spotify
+    # users.
+    # @param [ItemType2Enum] type Required parameter: Example:
+    # @param [String] ids Required parameter: TODO: type description here
+    # @param [MeFollowingRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def follow_artists_users(type,
+                             ids,
+                             body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/me/following',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(type, key: 'type'))
+                   .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 the current user as a follower of one or more artists or other
+    # Spotify users.
+    # @param [ItemType3Enum] type Required parameter: Example:
+    # @param [String] ids Required parameter: TODO: type description here
+    # @param [MeFollowingRequest1] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def unfollow_artists_users(type,
+                               ids,
+                               body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/me/following',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(type, key: 'type'))
+                   .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 to see if the current user is following one or more artists or other
+    # Spotify users.
+    # @param [ItemType3Enum] type Required parameter: Example:
+    # @param [String] ids Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def check_current_user_follows(type,
+                                   ids)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/me/following/contains',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(type, key: 'type'))
+                   .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
+
+    # Check to see if one or more Spotify users are following a specified
+    # playlist.
+    # @param [String] playlist_id Required parameter: TODO: type description
+    # here
+    # @param [String] ids Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def check_if_user_follows_playlist(playlist_id,
+                                       ids)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/playlists/{playlist_id}/followers/contains',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(playlist_id, key: 'playlist_id')
+                                    .should_encode(true))
+                   .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 the current user's top artists based on calculated affinity.
+    # @param [String] time_range Optional parameter: Example:medium_term
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [Integer] offset Optional parameter: Example:0
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_users_top_artists(time_range: 'medium_term',
+                              limit: 20,
+                              offset: 0)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/me/top/artists',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(time_range, key: 'time_range'))
+                   .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(PagingArtistObject.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 the current user's top tracks based on calculated affinity.
+    # @param [String] time_range Optional parameter: Example:medium_term
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [Integer] offset Optional parameter: Example:0
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_users_top_tracks(time_range: 'medium_term',
+                             limit: 20,
+                             offset: 0)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/me/top/tracks',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(time_range, key: 'time_range'))
+                   .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(PagingTrackObject.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/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/spotify_web_api/exceptions/bad_request_exception.rb

@@ -0,0 +1,46 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # BadRequest class.
+  class BadRequestException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ErrorObject]
+    attr_accessor :error
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = ErrorObject.from_hash(hash['error']) if hash['error']
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}>"
+    end
+  end
+end

data/lib/spotify_web_api/exceptions/forbidden_exception.rb

@@ -0,0 +1,46 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # Forbidden class.
+  class ForbiddenException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ErrorObject]
+    attr_accessor :error
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = ErrorObject.from_hash(hash['error']) if hash['error']
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}>"
+    end
+  end
+end

data/lib/spotify_web_api/exceptions/not_found_exception.rb

@@ -0,0 +1,46 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # NotFound class.
+  class NotFoundException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ErrorObject]
+    attr_accessor :error
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = ErrorObject.from_hash(hash['error']) if hash['error']
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}>"
+    end
+  end
+end

data/lib/spotify_web_api/exceptions/o_auth_provider_exception.rb

@@ -0,0 +1,64 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # OAuth 2 Authorization endpoint exception.
+  class OAuthProviderException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets error code.
+    # @return [OAuthProviderErrorEnum]
+    attr_accessor :error
+
+    # Gets or sets human-readable text providing additional information on
+    # error.
+    # Used to assist the client developer in understanding the error that
+    # occurred.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Gets or sets a URI identifying a human-readable web page with information
+    # about the error, used to provide the client developer with additional
+    # information about the error.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+      @error_description =
+        hash.key?('error_description') ? hash['error_description'] : SKIP
+      @error_uri = hash.key?('error_uri') ? hash['error_uri'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, error_description: #{@error_description}, error_uri:"\
+      " #{@error_uri}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, error_description: #{@error_description.inspect},"\
+      " error_uri: #{@error_uri.inspect}>"
+    end
+  end
+end

data/lib/spotify_web_api/exceptions/too_many_requests_exception.rb

@@ -0,0 +1,46 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # TooManyRequests class.
+  class TooManyRequestsException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ErrorObject]
+    attr_accessor :error
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = ErrorObject.from_hash(hash['error']) if hash['error']
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}>"
+    end
+  end
+end