shikimori-api 1.0.0

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

@@ -0,0 +1,329 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Clubs API
+      #
+      # @see https://shikimori.one/api/doc/1.0/clubs Shikimori's API documentation
+      module Clubs
+        # Get list of clubs
+        #
+        # @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 clubs per page. Must be a lower or equal that 30
+        # @option query [String] :search Filter by name of club
+        #
+        # @return [Array<Hash>] Array of hashes representing clubs
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/index Shikimori's API documentation
+        # @example Search a 20 clubs with name equal to 'yuri'
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.clubs(search: 'yuri')
+        def clubs(headers: nil, **query)
+          rest.get base_url.join('clubs').url, headers: headers, query: query
+        end
+
+        # Get a club by id
+        #
+        # @param id [#to_s] Club id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing club
+        #
+        # @raise [Shikimori::API::NotFoundError] if club not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/show Shikimori's API documentation
+        # @example Get a club with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.club(1)
+        def club(id, headers: nil, **query)
+          rest.get base_url.join('clubs', id.to_s).url, headers: headers, query: query
+        end
+
+        # Update Club.
+        # Requires `clubs` oauth scope
+        #
+        # @param id [#to_s] Club id
+        # @param club [Hash] Club data for updating
+        # @option club [String] :name Club's name
+        # @option club [String] :description Club's description
+        # @option club ['true', 'false', 1, 0] :display_images Display club's images?
+        # @option club ["free", "members", "admins"] :comment_policy Club's comments policy
+        # @option club ["members", "admins"] :topic_policy Club's topics policy
+        # @option club ["members", "admins"] :image_upload_policy Club's uploading images policy
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing updated club
+        #
+        # @raise [Shikimori::API::ForbiddenError] if user authorized without `clubs` scope
+        # @raise [Shikimori::API::NotFoundError] if club not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/update Shikimori's API documentation
+        # @example Update club's name and topic policy
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.update_club(1, { name: "Best of the best", topic_policy: "admins" }) #=> { id: 1, ... }
+        def update_club(id, club, headers: nil, **query)
+          rest.put base_url.join('clubs', id.to_s).url, { club: club }, headers: headers, query: query
+        end
+
+        # Get list of club's animes
+        #
+        # @param id [#to_s] Club's id
+        # @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 clubs per page. Must be a lower or equal that 20
+        #
+        # @return [Array<Hash>] Array of hashes representing club animes
+        #
+        # @raise [Shikimori::API::NotFoundError] if club not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/animes Shikimori's API documentation
+        # @example First 20 club animes
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.club_animes(limit: 20) #=> [{ id: 1, ...}, ...]
+        def club_animes(id, headers: nil, **query)
+          rest.get base_url.join('clubs', id.to_s, 'animes').url, headers: headers, query: query
+        end
+
+        # Get list of club's mangas
+        #
+        # @param id [#to_s] Club's id
+        # @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 clubs per page. Must be a lower or equal that 20
+        #
+        # @return [Array<Hash>] Array of hashes representing club mangas
+        #
+        # @raise [Shikimori::API::NotFoundError] if club not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/mangas Shikimori's API documentation
+        # @example First 20 club mangas
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.club_mangas(limit: 20) #=> [{ id: 1, ...}, ...]
+        def club_mangas(id, headers: nil, **query)
+          rest.get base_url.join('clubs', id.to_s, 'mangas').url, headers: headers, query: query
+        end
+
+        # Get list of club's ranobe
+        #
+        # @param id [#to_s] Club's id
+        # @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 clubs per page. Must be a lower or equal that 20
+        #
+        # @return [Array<Hash>] Array of hashes representing club ranobe
+        #
+        # @raise [Shikimori::API::NotFoundError] if club not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/ranobe Shikimori's API documentation
+        # @example First 20 club ranobe
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.club_ranobe(limit: 20) #=> [{ id: 1, ...}, ...]
+        def club_ranobe(id, headers: nil, **query)
+          rest.get base_url.join('clubs', id.to_s, 'ranobe').url, headers: headers, query: query
+        end
+
+        # Get list of club's characters
+        #
+        # @param id [#to_s] Club's id
+        # @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 clubs per page. Must be a lower or equal that 20
+        #
+        # @return [Array<Hash>] Array of hashes representing club characters
+        #
+        # @raise [Shikimori::API::NotFoundError] if club not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/characters Shikimori's API documentation
+        # @example First 20 club characters
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.club_characters(limit: 20) #=> [{ id: 1, ...}, ...]
+        def club_characters(id, headers: nil, **query)
+          rest.get base_url.join('clubs', id.to_s, 'characters').url, headers: headers, query: query
+        end
+
+        # Get list of club's collections
+        #
+        # @param id [#to_s] Club's id
+        # @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 clubs per page. Must be a lower or equal that 20
+        #
+        # @return [Array<Hash>] Array of hashes representing club collections
+        #
+        # @raise [Shikimori::API::NotFoundError] if club not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/collections Shikimori's API documentation
+        # @example First 20 club collections
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.club_collections(limit: 20) #=> [{ id: 1, ...}, ...]
+        def club_collections(id, headers: nil, **query)
+          rest.get base_url.join('clubs', id.to_s, 'collections').url, headers: headers, query: query
+        end
+
+        # Get list of club's clubs
+        #
+        # @param id [#to_s] Club's id
+        # @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 clubs per page. Must be a lower or equal that 20
+        #
+        # @return [Array<Hash>] Array of hashes representing club clubs
+        #
+        # @raise [Shikimori::API::NotFoundError] if club not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/clubs Shikimori's API documentation
+        # @example First 20 club clubs
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.club_clubs(limit: 20) #=> [{ id: 1, ...}, ...]
+        def club_clubs(id, headers: nil, **query)
+          rest.get base_url.join('clubs', id.to_s, 'clubs').url, headers: headers, query: query
+        end
+
+        # Get list of club's members
+        #
+        # @param id [#to_s] Club's id
+        # @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 clubs per page. Must be a lower or equal that 20
+        #
+        # @return [Array<Hash>] Array of hashes representing club members
+        #
+        # @raise [Shikimori::API::NotFoundError] if club not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/members Shikimori's API documentation
+        # @example First 20 club members
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.club_members(limit: 20) #=> [{ id: 1, ...}, ...]
+        def club_members(id, headers: nil, **query)
+          rest.get base_url.join('clubs', id.to_s, 'members').url, headers: headers, query: query
+        end
+
+        # Get list of club's images
+        #
+        # @param id [#to_s] Club's id
+        # @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 clubs per page. Must be a lower or equal that 100
+        #
+        # @return [Array<Hash>] Array of hashes representing club images
+        #
+        # @raise [Shikimori::API::NotFoundError] if club not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/images Shikimori's API documentation
+        # @example First 20 club images
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.club_images(limit: 20) #=> [{ id: 1, ...}, ...]
+        def club_images(id, headers: nil, **query)
+          rest.get base_url.join('clubs', id.to_s, 'images').url, headers: headers, query: query
+        end
+
+        # Join to club.
+        # Requires `clubs` oauth scope
+        # @param id [String] Club's id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Boolean] True if join successful, error otherwise.
+        #
+        # @raise [Shikimori::API::ForbiddenError] if user authorized without `clubs` scope
+        # @raise [Shikimori::API::NotFoundError] if club not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/join Shikimori's API documentation
+        # @example Join to club with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.join_club(1)
+        def join_club(id, headers: nil, **query)
+          rest.post base_url.join('clubs', id.to_s, 'join').url, {}, headers: headers, query: query
+
+          true
+        end
+
+        # Leave from club.
+        # Requires `clubs` oauth scope
+        # @param id [String] Club's id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Boolean] True if leave successful, error otherwise.
+        #
+        # @raise [Shikimori::API::ForbiddenError] if user authorized without `clubs` scope
+        # @raise [Shikimori::API::NotFoundError] if club not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/clubs/leave Shikimori's API documentation
+        # @example Leave from club with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.leave_club(1)
+        def leave_club(id, headers: nil, **query)
+          rest.post base_url.join('clubs', id.to_s, 'leave').url, {}, headers: headers, query: query
+
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Comments API
+      #
+      # @see https://shikimori.one/api/doc/1.0/comments Shikimori's API documentation
+      module Comments
+        # Get list of comments
+        #
+        # @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 comments per page. Must be a lower or equal that 30
+        # @option query [1, 0] :desc Sorting direction
+        # @option query [Integer] :commentable_id ID of object to comments requested
+        # @option query ['Topic', 'User'] :commentable_type Type of object to comments requested
+        #
+        # @return [Array<Hash>] Array of hashes representing comments
+        #
+        # @raise [Shikimori::API::NotFoundError] if commentable not exists
+        # @raise [Shikimori::API::RequestError] if commentable not sended
+        #
+        # @see https://shikimori.one/api/doc/1.0/comments/index Shikimori's API documentation
+        # @example Get a 10 comments for topic with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.comments(commentable_id: 1, commentable_type: 'Topic', limit: 10) #=> [{ id: 1, ... }, ...
+        def comments(headers: nil, **query)
+          rest.get base_url.join('comments').url, headers: headers, query: query
+        end
+
+        # Get a comment by id
+        #
+        # @param id [#to_s] Comment id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing comment
+        #
+        # @raise [Shikimori::API::NotFoundError] if comment not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/comments/show Shikimori's API documentation
+        # @example Get a comment with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.comment(1) #=> { id: 1, ... }
+        def comment(id, headers: nil, **query)
+          rest.get base_url.join('comments', id.to_s).url, headers: headers, query: query
+        end
+
+        # Create a comment
+        # Requires `comments` oauth scope
+        #
+        # @param comment [Hash] Comment data for creating
+        # @option comment [String] :body Comment text
+        # @option comment [Integer] :commentable_id ID of object to comment
+        # @option comment ['Topic', 'User', 'Anime',
+        #   'Manga', 'Character', 'Person',
+        #   'Article', 'Club', 'ClubPage',
+        #   'Collection', 'Critique', 'Review'] :commentable_type Type of object to comment
+        # @option comment ['true', 'false', 1, 0] :is_offtopic Mark comment as offtopic
+        # @param broadcast ['false', 'true', 1, 0] Used to broadcast
+        #   comment in club’s topic. Only club admins can broadcast.
+        # @param frontend ['false', 'true', 1, 0] Used by shikimori frontend code. Ignore it.
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing created comment
+        #
+        # @raise [Shikimori::API::RequestError] if bad request data
+        # @raise [Shikimori::API::NotFoundError] if commentable not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/comments/create Shikimori's API documentation
+        # @example Create a comment for topic with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.create_comment({ body: 'Hello, kitty! :)', commentable_type: 'Topic', commentable_id: 1 })
+        def create_comment(comment, broadcast: nil, frontend: nil, headers: nil, **query)
+          rest.post(
+            base_url.join('comments').url,
+            { broadcast: broadcast, comment: comment, frontend: frontend }.compact,
+            headers: headers, query: query
+          )
+        end
+
+        # Update Comment.
+        # Requires `comments` oauth scope.
+        # Use {Shikimori::API::V2::AbuseRequests#abuse_offtopic_request} to change is_offtopic field.
+        #
+        # @param id [#to_s] Comment id
+        # @param comment [Hash] Comment data for updating
+        # @option comment [String] :body Comment text
+        # @option comment [Integer] :commentable_id ID of object to comment
+        # @option comment ['Topic', 'User', 'Anime',
+        #   'Manga', 'Character', 'Person',
+        #   'Article', 'Club', 'ClubPage',
+        #   'Collection', 'Critique', 'Review'] :commentable_type Type of object to comment
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        # @option query ['false', 'true', 1, 0] :broadcast Used to broadcast
+        #   comment in club’s topic. Only club admins can broadcast.
+        # @option query ['false', 'true', 1, 0] :frontend Used by shikimori frontend code. Ignore it.
+        #
+        # @return [Hash] Hash representing updated comment
+        #
+        # @raise [Shikimori::API::RequestError] if bad request data
+        # @raise [Shikimori::API::NotFoundError] if comment not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/comments/update Shikimori's API documentation
+        # @example Update a comment's text with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.update_comment(1, { body: "new text!" })
+        def update_comment(id, comment, headers: nil, **query)
+          rest.put(
+            base_url.join('comments', id.to_s).url,
+            { broadcast: query.delete(:broadcast), comment: comment, frontend: query.delete(:frontend) }.compact,
+            headers: headers, query: query
+          )
+        end
+
+        # Delete Comment.
+        # Requires `comments` oauth scope
+        #
+        # @param id [String, Integer] Comment id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Boolean] True if deletion successful, false otherwise.
+        #
+        # @raise [Shikimori::API::NotFoundError] if comment not exists
+        #
+        # @see https://shikimori.one/api/doc/1.0/comments/destroy Shikimori's API documentation
+        # @example Delete a comment with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.delete_comment(1)
+        def delete_comment(id, headers: nil, **query)
+          rest.delete base_url.join('comments', id.to_s).url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Constants API
+      #
+      # @see https://shikimori.one/api/doc/1.0/constants Shikimori's API documentation
+      module Constants
+        # Get anime constants
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing constants
+        #
+        # @see https://shikimori.one/api/doc/1.0/constants/anime Shikimori's API documentation
+        # @example Get anime constants
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.anime_constants #=> { kind: [...], status: [...] }
+        def anime_constants(headers: nil, **query)
+          rest.get base_url.join('constants', 'anime').url, headers: headers, query: query
+        end
+
+        # Get manga constants
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing constants
+        #
+        # @see https://shikimori.one/api/doc/1.0/constants/manga Shikimori's API documentation
+        # @example Get manga constants
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.manga_constants #=> { kind: [...], status: [...] }
+        def manga_constants(headers: nil, **query)
+          rest.get base_url.join('constants', 'manga').url, headers: headers, query: query
+        end
+
+        # Get user rate constants
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing constants
+        #
+        # @see https://shikimori.one/api/doc/1.0/constants/user_rate Shikimori's API documentation
+        # @example Get user_rate constants
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.user_rate_constants #=> { status: [...] }
+        def user_rate_constants(headers: nil, **query)
+          rest.get base_url.join('constants', 'user_rate').url, headers: headers, query: query
+        end
+
+        # Get club constants
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing constants
+        #
+        # @see https://shikimori.one/api/doc/1.0/constants/club Shikimori's API documentation
+        # @example Get club constants
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.club_constants #=> { join_policy: [...], comment_policy: [...], image_upload_policy: [...] }
+        def club_constants(headers: nil, **query)
+          rest.get base_url.join('constants', 'club').url, headers: headers, query: query
+        end
+
+        # Get list of smileys constants
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Array<Hash>] Array of hashes representing constants
+        #
+        # @see https://shikimori.one/api/doc/1.0/constants/smileys Shikimori's API documentation
+        # @example Get smileys constants
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.smileys_constants #=> [{ bbcode: '...', path: '...' }, ...]
+        def smileys_constants(headers: nil, **query)
+          rest.get base_url.join('constants', 'smileys').url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Dialogs API
+      #
+      # @see https://shikimori.one/api/doc/1.0/dialogs Shikimori's API documentation
+      module Dialogs
+        # Get list of Dialogs.
+        # Requires `messages` oauth scope
+        #
+        # @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 dialogs per page. Must be a lower or equal that 20
+        #
+        # @return [Array<Hash>] Array of hashes representing dialogs
+        #
+        # @see https://shikimori.one/api/doc/1.0/dialogs/index Shikimori's API documentation
+        # @example Get list of dialogs
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.dialogs
+        def dialogs(headers: nil, **query)
+          rest.get base_url.join('dialogs').url, headers: headers, query: query
+        end
+
+        # Get a dialog by username.
+        # Requires `messages` oauth scope
+        #
+        # @param username [#to_s] Dialog's username
+        # @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 dialogs per page. Must be a lower or equal that 20
+        #
+        # @return [Hash] Hash representing dialog
+        #
+        # @see https://shikimori.one/api/doc/1.0/dialogs/show Shikimori's API documentation
+        # @example Get dialog with username equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.dialog('user_12') #=> [{ id: 1, ... }]
+        def dialog(username, headers: nil, **query)
+          rest.get base_url.join('dialogs', username.to_s).url, headers: headers, query: query
+        end
+
+        # Delete Dialog.
+        # Requires `messages` oauth scope
+        #
+        # @param username [#to_s] Dialog's username
+        # @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/dialogs/destroy Shikimori's API documentation
+        # @example Delete dialog with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.delete_dialog('user_12') #=> true
+        def delete_dialog(username, headers: nil, **query)
+          rest.delete base_url.join('dialogs', username.to_s).url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end