shikimori-api 1.0.0

data/sig/shikimori/api/v1/mangas.rbs

@@ -0,0 +1,23 @@
+module Shikimori
+  module API
+    class V1
+      module Mangas
+        attr_reader rest: REST
+
+        def mangas: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def manga: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def manga_roles: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def manga_similar: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def manga_related: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def manga_screenshots: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def manga_franchise: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def manga_external_links: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def manga_topics: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/messages.rbs

@@ -0,0 +1,20 @@
+module Shikimori
+  module API
+    class V1
+      module Messages
+        attr_reader rest: REST
+
+        def message: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def create_message: ({ body: String, from_id: Integer, to_id: Integer, kind: 'Private' | nil }, ?frontend: 'false' | 'true' | 1 | 0 | nil, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def update_message: (_ToS, { body: String }, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_message: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def read_all_messages: (type: 'news' | 'notifications', ?frontend: 'false' | 'true' | 1 | 0 | nil, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_all_messages: (type: 'news' | 'notifications', ?frontend: 'false' | 'true' | 1 | 0 | nil, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/people.rbs

@@ -0,0 +1,16 @@
+module Shikimori
+  module API
+    class V1
+      module People
+        attr_reader rest: REST
+
+        def people: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def person: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/publishers.rbs

@@ -0,0 +1,15 @@
+module Shikimori
+  module API
+    class V1
+      module Publishers
+        attr_reader rest: REST
+
+        def publishers: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/ranobe.rbs

@@ -0,0 +1,23 @@
+module Shikimori
+  module API
+    class V1
+      module Ranobe
+        attr_reader rest: REST
+
+        def ranobes: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def ranobe: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def ranobe_roles: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def ranobe_similar: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def ranobe_related: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def ranobe_screenshots: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def ranobe_franchise: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def ranobe_external_links: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def ranobe_topics: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/reviews.rbs

@@ -0,0 +1,19 @@
+module Shikimori
+  module API
+    class V1
+      module Reviews
+        attr_reader rest: REST
+
+        type opinions = 'positive' | 'neutral' | 'negative'
+
+        def create_review: ({ body: String, anime_id: Integer, opinion: opinions }, ?frontend: 'true' | 'false' | 0 | 1 | nil, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def update_review: (_ToS, { body: String, opinion: opinions }, ?frontend: 'true' | 'false' | 0 | 1 | nil, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_review: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/stats.rbs

@@ -0,0 +1,15 @@
+module Shikimori
+  module API
+    class V1
+      module Stats
+        attr_reader rest: REST
+
+        def active_users: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/studios.rbs

@@ -0,0 +1,15 @@
+module Shikimori
+  module API
+    class V1
+      module Studios
+        attr_reader rest: REST
+
+        def studios: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/styles.rbs

@@ -0,0 +1,18 @@
+module Shikimori
+  module API
+    class V1
+      module Styles
+        attr_reader rest: REST
+
+        def style: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def create_style: ({ css: String, name: String, owner_id: Integer, owner_type: 'User' | 'Club' }, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def update_style: (_ToS, { css: String, name: String }, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def preview_style: ({ css: String }, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/topic_ignores.rbs

@@ -0,0 +1,16 @@
+module Shikimori
+  module API
+    class V1
+      module TopicIgnores
+        attr_reader rest: REST
+
+        def create_topic_ignore: (topic_id: _ToS, user_id: _ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_topic_ignore: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/topics.rbs

@@ -0,0 +1,40 @@
+module Shikimori
+  module API
+    class V1
+      module Topics
+        attr_reader rest: REST
+
+        TOPIC_TYPES_MAP: Hash[String, String]
+
+        type creation_topic = {
+          title: String,
+          body: String,
+          linked_id: Integer,
+          linked_type: 'Anime' | 'Manga' | 'Ranobe' | 'Character' | 'Person' | 'Club' | 'ClubPage' | 'Critique' | 'Review' | 'Contest' | 'CosplayGallery' | 'Collection' | 'Article',
+          type: 'Topic',
+          forum_id: Integer,
+          user_id: Integer
+        }
+
+        type updation_topic = {
+          title: String,
+          body: String,
+          linked_id: Integer,
+          linked_type: 'Anime' | 'Manga' | 'Ranobe' | 'Character' | 'Person' | 'Club' | 'ClubPage' | 'Critique' | 'Review' | 'Contest' | 'CosplayGallery' | 'Collection' | 'Article',
+        }
+
+        def topics: (?type: String | nil, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def topic: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def create_topic: (creation_topic, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def update_topic: (_ToS, updation_topic, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_topic: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+        def topics_updates: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def hot_topics: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/user_images.rbs

@@ -0,0 +1,15 @@
+module Shikimori
+  module API
+    class V1
+      module UserImages
+        attr_reader rest: REST
+
+        def create_user_image: (File, ?linked_type: 'Comment' | nil, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/user_rates.rbs

@@ -0,0 +1,44 @@
+module Shikimori
+  module API
+    class V1
+      module UserRates
+        attr_reader rest: REST
+
+        type user_rate_creation = {
+          user_id: Integer,
+          target_id: Integer,
+          target_type: 'Anime' | 'Manga',
+          status: String,
+          score: Numeric,
+          chapters: Numeric,
+          episodes: Numeric,
+          volumes: Numeric,
+          rewatches: Numeric,
+          text: String
+        }
+
+        type user_rate_updation = {
+          status: String,
+          score: Numeric,
+          chapters: Numeric,
+          episodes: Numeric,
+          volumes: Numeric,
+          rewatches: Numeric,
+          text: String
+        }
+
+        def user_rate: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def create_user_rate: (user_rate_creation, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def update_user_rate: (_ToS, user_rate_updation, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_user_rate: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+        def increment_user_rate: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+        def cleanup_user_rates: ('anime' | 'manga', ?headers: Hash[String, String] | nil, **untyped) -> bool
+        def reset_user_rates: ('anime' | 'manga', ?headers: Hash[String, String] | nil, **untyped) -> bool
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/users.rbs

@@ -0,0 +1,28 @@
+module Shikimori
+  module API
+    class V1
+      module Users
+        attr_reader rest: REST
+
+        def users: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user_info: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def whoami: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def sign_out: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user_friends: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user_clubs: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user_anime_rates: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user_manga_rates: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user_favorites: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user_messages: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user_unread_messages: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user_history: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user_bans: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/videos.rbs

@@ -0,0 +1,23 @@
+module Shikimori
+  module API
+    class V1
+      module Videos
+        attr_reader rest: REST
+
+        type creation_video = {
+          name: String,
+          kind: 'pv' | 'character_trailer' | 'cm' | 'op' | 'ed' | 'op_ed_clip' | 'clip' | 'other' | 'episode_preview',
+          url: String,
+        }
+
+        def anime_videos: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def create_anime_video: (_ToS, creation_video,  ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_anime_video: (anime_id: _ToS, video_id: _ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1.rbs

@@ -0,0 +1,41 @@
+module Shikimori
+  module API
+    class V1
+      include Videos
+      include Users
+      include UserRates
+      include UserImages
+      include Topics
+      include TopicIgnores
+      include Styles
+      include Studios
+      include Stats
+      include Reviews
+      include Ranobe
+      include Publishers
+      include People
+      include Messages
+      include Mangas
+      include Ignores
+      include Genres
+      include Friends
+      include Forums
+      include Favorites
+      include Dialogs
+      include Constants
+      include Comments
+      include Clubs
+      include Characters
+      include Calendars
+      include Bans
+      include Appear
+      include Animes
+      include Achievements
+
+      attr_reader rest: REST
+      attr_reader base_url: ::Shikimori::API::URI
+
+      def initialize: (base_url: ::Shikimori::API::URI, rest: REST) -> void
+    end
+  end
+end

data/sig/shikimori/api/v2/abuse_requests.rbs

@@ -0,0 +1,18 @@
+module Shikimori
+  module API
+    class V2
+      module AbuseRequests
+        attr_reader rest: REST
+
+        def abuse_offtopic_request: ({comment_id: Integer }, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def abuse_review_request: ({comment_id: Integer, topic_id: Integer }, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def abuse_request: ({comment_id: Integer, topic_id: Integer, reason: String}, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def abuse_spoiler_request: ({comment_id: Integer, topic_id: Integer, reason: String}, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v2/episode_notifications.rbs

@@ -0,0 +1,25 @@
+module Shikimori
+  module API
+    class V2
+      module EpisodeNotifications
+        attr_reader rest: REST
+
+        type notification_creation = {
+          anime_id: Integer,
+          episode: Integer,
+          aired_at: String | DateTime,
+          is_fandub: 'true' | 'false' | 1 | 0,
+          is_raw: 'true' | 'false' | 1 | 0,
+          is_subtitles: 'true' | 'false' | 1 | 0,
+          is_anime365: 'true' | 'false' | 1 | 0,
+        }
+
+        def create_episode_notification: (notification_creation, token: String, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v2/topic_ignore.rbs

@@ -0,0 +1,16 @@
+module Shikimori
+  module API
+    class V2
+      module TopicIgnore
+        attr_reader rest: REST
+
+        def create_topic_ignore: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_topic_ignore: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v2/user_ignore.rbs

@@ -0,0 +1,16 @@
+module Shikimori
+  module API
+    class V2
+      module UserIgnore
+        attr_reader rest: REST
+
+        def create_user_ignore: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_user_ignore: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v2/user_rates.rbs

@@ -0,0 +1,43 @@
+module Shikimori
+  module API
+    class V2
+      module UserRates
+        attr_reader rest: REST
+
+        type user_rate_creation = {
+          user_id: Integer,
+          target_id: Integer,
+          target_type: 'Anime' | 'Manga',
+          status: String,
+          score: Numeric,
+          chapters: Numeric,
+          episodes: Numeric,
+          volumes: Numeric,
+          rewatches: Numeric,
+          text: String
+        }
+
+        type user_rate_updation = {
+          status: String,
+          score: Numeric,
+          chapters: Numeric,
+          episodes: Numeric,
+          volumes: Numeric,
+          rewatches: Numeric,
+          text: String
+        }
+
+        def user_rates: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user_rate: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def create_user_rate: (user_rate_creation, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def update_user_rate: (_ToS, user_rate_updation, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_user_rate: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+        def increment_user_rate: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v2.rbs

@@ -0,0 +1,16 @@
+module Shikimori
+  module API
+    class V2
+      include AbuseRequests
+      include EpisodeNotifications
+      include TopicIgnore
+      include UserIgnore
+      include UserRates
+
+      attr_reader rest: REST
+      attr_reader base_url: ::Shikimori::API::URI
+
+      def initialize: (base_url: ::Shikimori::API::URI, rest: REST) -> void
+    end
+  end
+end

data/sig/shikimori/api/version.rbs

@@ -0,0 +1,5 @@
+module Shikimori
+  module API
+    VERSION: String
+  end
+end

data/sig/shikimori/api.rbs

@@ -0,0 +1,18 @@
+module Shikimori
+  module API
+    class RequestError < StandardError
+    end
+
+    class NotFoundError < RequestError
+    end
+
+    class ForbiddenError < RequestError
+    end
+
+    class BadRequestError < RequestError
+      attr_reader errors: Array[String]
+
+      def initialize: (Array[String] | { "errors" => Array[String] }) -> void
+    end
+  end
+end