shikimori-api 1.0.0

data/lib/shikimori/api/v1/styles.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Styles API
+      #
+      # @see https://shikimori.one/api/doc/1.0/styles Shikimori's API documentation
+      module Styles
+        # Get a style
+        #
+        # @param id [#to_s] Style id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing style
+        #
+        # @see https://shikimori.one/api/doc/1.0/styles/show Shikimori's API documentation
+        # @example Get a style with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.style(1)
+        def style(id, headers: nil, **query)
+          rest.get base_url.join('styles', id.to_s).url, headers: headers, query: query
+        end
+
+        # Create style
+        #
+        # @param style [Hash] Style data for creating
+        # @option style [String] :css Style CSS content
+        # @option style [String] :name Style name
+        # @option style [Integer] :owner_id Owner ID
+        # @option style ['User', 'Club'] :owner_type Owner type
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing created style
+        #
+        # @see https://shikimori.one/api/doc/1.0/styles/create Shikimori's API documentation
+        # @example Create a red background style
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.create_style({
+        #     name: 'Red background',
+        #     css: 'body: { background: red !important; }',
+        #     owner_id: 1,
+        #     owner_type: 'User'
+        #   })
+        def create_style(style, headers: nil, **query)
+          rest.post base_url.join('styles').url, { style: style }, headers: headers, query: query
+        end
+
+        # Update style
+        #
+        # @param id [Hash] Style's ID
+        # @param style [Hash] Style data for updating
+        # @option style [String] :css Style CSS content
+        # @option style [String] :name Style name
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing updated style
+        #
+        # @see https://shikimori.one/api/doc/1.0/styles/update Shikimori's API documentation
+        # @example Change style from red background to green
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #
+        #   client.v1.update_style(
+        #     1,
+        #     { name: 'Green background', css: 'body: { background: green !important; }', }
+        #   )
+        def update_style(id, style, headers: nil, **query)
+          rest.put base_url.join('styles', id.to_s).url, { style: style }, headers: headers, query: query
+        end
+
+        # Preview style
+        #
+        # @param style [Hash] Style data for preview
+        # @option style [String] :css Style CSS content
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing updated style
+        #
+        # @see https://shikimori.one/api/doc/1.0/styles/preview Shikimori's API documentation
+        # @example Preview style with green background
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.preview_style(
+        #     1,
+        #     { css: 'body: { background: green !important; }', }
+        #   )
+        def preview_style(style, headers: nil, **query)
+          rest.post base_url.join('styles', 'preview').url, { style: style }, headers: headers, query: query
+        end
+      end
+    end
+  end
+end

data/lib/shikimori/api/v1/topic_ignores.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Topic ignores API
+      #
+      # @deprecated Use {Shikimori::API::V2::TopicIgnore} instead
+      #
+      # @see https://shikimori.one/api/doc/1.0/topic_ignores Shikimori's API documentation
+      module TopicIgnores
+        # Add user to ignore at topic by user id and topic id.
+        # Requires `topics` oauth scope
+        #
+        # @param topic_id [Integer] Topic id where to add
+        # @param user_id [Integer] User id that add to ignores
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing created topic ignore
+        #
+        # @see https://shikimori.one/api/doc/1.0/topic_ignores/create Shikimori's API documentation
+        # @example Add to ignore a user with id equal to 1 at topic with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.create_topic_ignore(topic_id: 1, user_id: 1)
+        #
+        # @deprecated Use {Shikimori::API::V2::TopicIgnore#create_topic_ignore} instead
+        def create_topic_ignore(topic_id:, user_id:, headers: nil, **query)
+          payload = { topic_ignore: { topic_id: topic_id, user_id: user_id } }
+
+          rest.post base_url.join('topic_ignores').url, payload, headers: headers, query: query
+        end
+
+        # Delete a user from topic ignores by id.
+        # Requires `ignores` oauth scope
+        #
+        # @param id [#to_s] Topic ignore id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Boolean] True if deletion successful, false otherwise.
+        #
+        # @see https://shikimori.one/api/doc/1.0/topic_ignores/destroy Shikimori's API documentation
+        # @example Delete a topic ignore
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.delete_topic_ignore(1)
+        #
+        # @deprecated Use {Shikimori::API::V2::TopicIgnore#delete_topic_ignore} instead
+        def delete_topic_ignore(id, headers: nil, **query)
+          rest.delete base_url.join('topic_ignores', id.to_s).url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end

data/lib/shikimori/api/v1/topics.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Topics API
+      #
+      # @see https://shikimori.one/api/doc/1.0/topics Shikimori's API documentation
+      module Topics
+        TOPIC_TYPES_MAP = {
+          'topic' => 'Topic',
+          'club_user' => 'Topics::ClubUserTopic',
+          'entry_topic' => 'Topics::EntryTopic',
+          'anime' => 'Topics::EntryTopics::AnimeTopic',
+          'article' => 'Topics::EntryTopics::ArticleTopic',
+          'character' => 'Topics::EntryTopics::CharacterTopic',
+          'club_page' => 'Topics::EntryTopics::ClubPageTopic',
+          'club' => 'Topics::EntryTopics::ClubTopic',
+          'collection' => 'Topics::EntryTopics::CollectionTopic',
+          'contest' => 'Topics::EntryTopics::ContestTopic',
+          'cosplay_gallery' => 'Topics::EntryTopics::CosplayGalleryTopic',
+          'manga' => 'Topics::EntryTopics::MangaTopic',
+          'person' => 'Topics::EntryTopics::PersonTopic',
+          'ranobe' => 'Topics::EntryTopics::RanobeTopic',
+          'critique' => 'Topics::EntryTopics::CritiqueTopic',
+          'review' => 'Topics::EntryTopics::ReviewTopic',
+          'news' => 'Topics::NewsTopic',
+          'contest_status' => 'Topics::NewsTopics::ContestStatusTopic'
+        }.freeze
+
+        # Get list of topics
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        # @option query [Integer] :page Number of page. Must be between 1 and 100000
+        # @option query [Integer] :limit Number of titles per page. Must be a lower or equal that 30
+        # @option query ['all', 'animanga', 'site',
+        #   'games', 'vn', 'contests',
+        #   'offtopic', 'clubs', 'my_clubs',
+        #   'critiques', 'news', 'collections',
+        #   'articles', 'cosplay'] :forum Forum type
+        # @option query [Integer] :linked_id Linked object ID
+        # @option query ['Anime', 'Manga', 'Ranobe',
+        #   'Character', 'Person', 'Club',
+        #   'ClubPage', 'Critique', 'Review',
+        #   'Contest', 'CosplayGallery',
+        #   'Collection', 'Article'] :linked_type Linked object type
+        # @option query ['topic', 'club_user', 'entry_topic',
+        #   'anime', 'article', 'character',
+        #   'club_page', 'club', 'collection',
+        #   'contest', 'cosplay_gallery', 'manga',
+        #   'person', 'ranobe', 'critique',
+        #   'review', 'news', 'contest_status'] :type Type of topic
+        #
+        # @return [Array<Hash>] Array of hashes representing topics
+        #
+        # @see https://shikimori.one/api/doc/1.0/topics/index Shikimori's API documentation
+        # @example Get list of topics
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.topics #=> [{ id: 1, ... }, ...]
+        def topics(type: nil, headers: nil, **query)
+          topic_type = type && TOPIC_TYPES_MAP[type]
+
+          rest.get base_url.join('topics').url, headers: headers, query: query.merge(
+            type: topic_type
+          ).compact
+        end
+
+        # Get an topic by id
+        #
+        # @param id [#to_s] Topic id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing topic
+        #
+        # @see https://shikimori.one/api/doc/1.0/topics/show Shikimori's API documentation
+        # @example Get topic with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.topic(1) #=> { id: 1, ... }
+        def topic(id, headers: nil, **query)
+          rest.get base_url.join('topics', id.to_s).url, headers: headers, query: query
+        end
+
+        # Create a topic.
+        # Requires `topics` oauth scope
+        #
+        # @param topic [Hash] Topic data for creating
+        # @option topic [String] :title Topic title
+        # @option topic ['Topic'] :type Topic type
+        # @option topic [String] :body Topic text
+        # @option topic [Integer] :forum_id ID of forum
+        # @option topic [Integer] :user_id ID of user created a topic
+        # @option topic [Integer] :linked_id ID of linked object to topic
+        # @option topic ['Anime', 'Manga', 'Ranobe',
+        #   'Character', 'Person', 'Club',
+        #   'ClubPage', 'Critique', 'Review',
+        #   'Contest', 'CosplayGallery',
+        #   'Collection', 'Article'] :linked_type Type of linked object to topic
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing created topic
+        #
+        # @see https://shikimori.one/api/doc/1.0/topics/create Shikimori's API documentation
+        # @example Create a topic
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   topic = {
+        #     body: "text",
+        #     forum_id: "1",
+        #     linked_id: "41",
+        #     linked_type: "Anime",
+        #     title: "zxc",
+        #     type: "Topic",
+        #     user_id: "23456791"
+        #   }
+        #   client.v1.create_topic(topic)
+        def create_topic(topic, headers: nil, **query)
+          rest.post(
+            base_url.join('topics').url,
+            { topic: topic }.compact,
+            headers: headers, query: query
+          )
+        end
+
+        # Update Topic
+        # Requires `topics` oauth scope
+        #
+        # @param id [#to_s] Topic id
+        # @param topic [Hash] Topic data for updating
+        # @option topic [String] :title Topic title
+        # @option topic [String] :body Topic text
+        # @option topic [Integer] :linked_id ID of linked object to topic
+        # @option topic ['Anime', 'Manga', 'Ranobe',
+        #   'Character', 'Person', 'Club',
+        #   'ClubPage', 'Critique', 'Review',
+        #   'Contest', 'CosplayGallery',
+        #   'Collection', 'Article'] :linked_type Type of linked object to topic
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing updated topic
+        #
+        # @see https://shikimori.one/api/doc/1.0/topics/update Shikimori's API documentation
+        # @example Update a topic
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   topic = {
+        #     body: "text",
+        #     linked_id: "41",
+        #     linked_type: "Anime",
+        #     title: "zxc",
+        #   }
+        #   client.v1.update_topic(topic)
+        def update_topic(id, topic, headers: nil, **query)
+          rest.put base_url.join('topics', id.to_s).url, { topic: topic }, headers: headers, query: query
+        end
+
+        # Delete Topic
+        #
+        # @param id [String, Integer] Topic id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Boolean] True if deletion successful, false otherwise.
+        #
+        # @see https://shikimori.one/api/doc/1.0/topics/destroy Shikimori's API documentation
+        # @example Delete a topic with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.delete_topic(1)
+        def delete_topic(id, headers: nil, **query)
+          rest.delete base_url.join('topics', id.to_s).url, headers: headers, query: query
+        end
+
+        # Get topics updates
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        # @option query [Integer] :page Number of page. Must be between 1 and 100000
+        # @option query [Integer] :limit Number of titles per page. Must be a lower or equal that 30
+        #
+        # @return [Array<Hash>] Array of hashes representing topic updates
+        #
+        # @see https://shikimori.one/api/doc/1.0/topics/updates Shikimori's API documentation
+        # @example Get list of topics updates
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.topics_updates #=> [{ id: 1, ... }, ...]
+        def topics_updates(headers: nil, **query)
+          rest.get base_url.join('topics', 'updates').url, headers: headers, query: query
+        end
+
+        # Get hot topics
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        # @option query [Integer] :limit Number of titles per page. Must be a lower or equal that 10
+        #
+        # @return [Array<Hash>] Array of hashes representing topic updates
+        #
+        # @see https://shikimori.one/api/doc/1.0/topics/hot Shikimori's API documentation
+        # @example Get list of hot topics
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.hot_topics #=> [{ id: 1, ... }, ...]
+        def hot_topics(headers: nil, **query)
+          rest.get base_url.join('topics', 'hot').url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end

data/lib/shikimori/api/v1/user_images.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the User images API
+      #
+      # @see https://shikimori.one/api/doc/1.0/user_images Shikimori's API documentation
+      module UserImages
+        # Create User image.
+        # Requires `comments` oauth scope
+        #
+        # @param image [File] Image file
+        # @param linked_type ['Comment'] Linking type
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing created user image
+        #
+        # @see https://shikimori.one/api/doc/1.0/user_images/create Shikimori's API documentation
+        # @example Create user's image
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.create_user_image(File.open('/tmp/file.jpg'), linked_type: 'Comment')
+        def create_user_image(image, linked_type: nil, headers: nil, **query)
+          rest.post base_url.join('user_images').url,
+                    { 'image' => image, 'linked_type' => linked_type }.compact,
+                    headers: headers, query: query, as_form: true
+        end
+      end
+    end
+  end
+end

data/lib/shikimori/api/v1/user_rates.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the User rates API
+      #
+      # @see https://shikimori.one/api/doc/1.0/user_rates Shikimori's API documentation
+      module UserRates
+        # Get an user rate by id
+        #
+        # @param id [#to_s] user rate id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing user rate
+        #
+        # @see https://shikimori.one/api/doc/1.0/user_rates/show Shikimori's API documentation
+        # @example Get user rate with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.user_rate(1) #=> { id: 1, ... }
+        #
+        # @deprecated Use {Shikimori::API::V2::UserRates#user_rate} instead
+        def user_rate(id, headers: nil, **query)
+          rest.get base_url.join('user_rates', id.to_s).url, headers: headers, query: query
+        end
+
+        # Create a user rate.
+        # Requires `user_rates` oauth scope
+        #
+        # @param user_rate [Hash] User rate data for creating
+        # @option user_rate [Integer] :user_id User id
+        # @option user_rate [Integer] :target_id Target id
+        # @option user_rate ['Anime', 'Manga'] :target_type Target type
+        # @option user_rate ["planned", "watching", "rewatching",
+        #   "completed", "on_hold", "dropped"] :status Watching status
+        # @option user_rate [Numeric] :score Score
+        # @option user_rate [Numeric] :chapters Current chapter number
+        # @option user_rate [Numeric] :episodes Current episode number
+        # @option user_rate [Numeric] :volumes Current volume number
+        # @option user_rate [Numeric] :rewatches Count of rewatching
+        # @option user_rate [String] :text Rate text
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing created user rate
+        #
+        # @see https://shikimori.one/api/doc/1.0/user_rates/create Shikimori's API documentation
+        # @example Create a user rate
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   user_rate = {
+        #     text: "text",
+        #     user_id: 1,
+        #     target_id: "41",
+        #     target_type: "Anime"
+        #   }
+        #   client.v1.create_user_rate(user_rate)
+        #
+        # @deprecated Use {Shikimori::API::V2::UserRates#create_user_rate} instead
+        def create_user_rate(user_rate, headers: nil, **query)
+          rest.post base_url.join('user_rates').url, { user_rate: user_rate }, headers: headers, query: query
+        end
+
+        # Update a user rate.
+        # Requires `user_rates` oauth scope
+        #
+        # @param id [#to_s] User rate id
+        # @param user_rate [Hash] User rate data for creating
+        # @option user_rate ["planned", "watching", "rewatching",
+        #   "completed", "on_hold", "dropped"] :status Watching status
+        # @option user_rate [Numeric] :score Score
+        # @option user_rate [Numeric] :chapters Current chapter number
+        # @option user_rate [Numeric] :episodes Current episode number
+        # @option user_rate [Numeric] :volumes Current volume number
+        # @option user_rate [Numeric] :rewatches Count of rewatching
+        # @option user_rate [String] :text Rate text
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing updated user rate
+        #
+        # @see https://shikimori.one/api/doc/1.0/user_rates/update Shikimori's API documentation
+        # @example Update a user rate text
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   user_rate = {
+        #     text: "text"
+        #   }
+        #   client.v1.update_user_rate(1, user_rate)
+        #
+        # @deprecated Use {Shikimori::API::V2::UserRates#update_user_rate} instead
+        def update_user_rate(id, user_rate, headers: nil, **query)
+          rest.put base_url.join('user_rates', id.to_s).url, { user_rate: user_rate }, headers: headers, query: query
+        end
+
+        # Delete user rate
+        #
+        # @param id [#to_s] User rate id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Boolean] True if deletion successful, false otherwise.
+        #
+        # @see https://shikimori.one/api/doc/1.0/user_rates/destroy Shikimori's API documentation
+        # @example Delete user rate
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.delete_user_rate(1)
+        #
+        # @deprecated Use {Shikimori::API::V2::UserRates#delete_user_rate} instead
+        def delete_user_rate(id, headers: nil, **query)
+          rest.delete base_url.join('user_rates', id.to_s).url, headers: headers, query: query
+        end
+
+        # Increment episodes/chapters by 1
+        # Requires `user_rates` oauth scope
+        #
+        # @param id [#to_s] User rate ID
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing created user rate
+        #
+        # @see https://shikimori.one/api/doc/1.0/user_rates/increment Shikimori's API documentation
+        # @example Increment episodes/chapters by 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.increment_user_rate(1)
+        #
+        # @deprecated Use {Shikimori::API::V2::UserRates#increment_user_rate} instead
+        def increment_user_rate(id, headers: nil, **query)
+          rest.post base_url.join('user_rates', id.to_s, 'increment').url, {}, headers: headers, query: query
+        end
+
+        # Delete entire user rates and history
+        #
+        # @param type ['anime', 'manga'] Type of cleanup
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Boolean] True if deletion successful, false otherwise.
+        #
+        # @see https://shikimori.one/api/doc/1.0/user_rates/cleanup Shikimori's API documentation
+        # @example Delete entire user rates and history
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.cleanup_user_rates('manga')
+        def cleanup_user_rates(type, headers: nil, **query)
+          rest.delete base_url.join('user_rates', type.to_s, 'cleanup').url, headers: headers, query: query
+        end
+
+        # Reset all user scores to 0
+        #
+        # @param type ['anime', 'manga'] Type of reset
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Boolean] True if deletion successful, false otherwise.
+        #
+        # @see https://shikimori.one/api/doc/1.0/user_rates/reset Shikimori's API documentation
+        # @example Reset all user scores to 0
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.reset_user_rates('manga')
+        def reset_user_rates(type, headers: nil, **query)
+          rest.delete base_url.join('user_rates', type.to_s, 'reset').url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end