discorb 0.17.1 → 0.19.0

data/sig/discorb/embed.rbs

@@ -0,0 +1,286 @@
+module Discorb
+  #
+  # Represents an embed of discord.
+  class Embed
+    #
+    # Initialize a new Embed object.
+    #
+    # @param [String] title The title of embed.
+    # @param [String] description The description of embed.
+    # @param [Discorb::Color, Integer] color The color of embed.
+    # @param [String] url The url of embed.
+    # @param [Time] timestamp The timestamp of embed.
+    # @param [Discorb::Embed::Author] author The author field of embed.
+    # @param [Array<Discorb::Embed::Field>] fields The fields of embed.
+    # @param [Discorb::Embed::Footer] footer The footer of embed.
+    # @param [Discorb::Embed::Image, String] image The image of embed.
+    # @param [Discorb::Embed::Thumbnail, String] thumbnail The thumbnail of embed.
+    def initialize: (
+      ?String? title,
+      ?String? description,
+      ?color: (Discorb::Color | Integer)?,
+      ?url: String?,
+      ?timestamp: Time?,
+      ?author: Discorb::Embed::Author?,
+      ?fields: ::Array[Discorb::Embed::Field]?,
+      ?footer: Discorb::Embed::Footer?,
+      ?image: (Discorb::Embed::Image | String)?,
+      ?thumbnail: (Discorb::Embed::Thumbnail | String)?
+    ) -> void
+
+    #
+    # Initialize embed from hash.
+    # @private
+    #
+    # @param [Hash] data The hash data to initialize embed.
+    def initialize_hash: (Discorb::json data) -> untyped
+
+    %a{pure}
+    def inspect: -> String
+
+    #
+    # Convert embed to hash.
+    #
+    # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-structure Offical Discord API Docs
+    # @return [Hash] Converted embed.
+    %a{pure}
+    def to_hash: -> Discorb::json
+
+    def self.from_hash: (untyped data) -> untyped
+
+    # @return [String, nil] The title of embed.
+    attr_accessor title: String?
+
+    # @return [String, nil] The description of embed.
+    attr_accessor description: String?
+
+    # @return [String, nil] The url of embed.
+    attr_accessor url: String?
+
+    # @return [Time, nil] The timestamp of embed.
+    attr_accessor timestamp: Time?
+
+    # @return [Discorb::Color, nil] The color of embed.
+    attr_accessor color: Discorb::Color?
+
+    # @return [Discorb::Embed::Author, nil] The author of embed.
+    attr_accessor author: Discorb::Embed::Author?
+
+    # @return [Array<Discorb::Embed::Field>] The fields of embed.
+    attr_accessor fields: ::Array[Discorb::Embed::Field]
+
+    # @return [Discorb::Embed::Footer, nil] The footer of embed.
+    attr_accessor footer: Discorb::Embed::Footer?
+
+    # @return [Symbol] The type of embed.
+    attr_reader type: Symbol
+
+    # @return [Discorb::Embed::Image] The image of embed.
+    attr_accessor image: Discorb::Embed::Image?
+
+    # @return [Discorb::Embed::Thumbnail] The thumbnail of embed.
+    attr_accessor thumbnail: Discorb::Embed::Thumbnail?
+
+    #
+    # Represents an entry in embed.
+    # @abstract
+    # @private
+    class Entry
+      %a{pure}
+      def inspect: -> String
+    end
+
+    #
+    # Represents an author of embed.
+    class Author < Discorb::Embed::Entry
+      #
+      # Initialize a new Author object.
+      #
+      # @param [String] name The name of author.
+      # @param [String] url The url of author.
+      # @param [String] icon The icon url of author.
+      def initialize: (String name, ?url: String?, ?icon: String?) -> void
+
+      #
+      # Convert author to hash.
+      #
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure
+      #   Offical Discord API Docs
+      # @return [Hash] Converted author.
+      def to_hash: -> Discorb::json
+
+      # @return [String] The name of author.
+      attr_accessor name: String
+
+      # @return [String, nil] The url of author.
+      attr_accessor url: String?
+
+      # @return [String, nil] The icon url of author.
+      attr_accessor icon: String?
+    end
+
+    #
+    # Represemts a footer of embed.
+    class Footer < Discorb::Embed::Entry
+      #
+      # Initialize a new Footer object.
+      #
+      # @param [String] text The text of footer.
+      # @param [String] icon The icon url of footer.
+      def initialize: (String text, ?icon: String?) -> void
+
+      #
+      # Convert footer to hash.
+      #
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure
+      #   Offical Discord API Docs
+      # @return [Hash] Converted footer.
+      %a{pure}
+      def to_hash: -> Discorb::json
+
+      # Returns the value of attribute text.
+      attr_accessor text: untyped
+
+      # Returns the value of attribute icon.
+      attr_accessor icon: untyped
+    end
+
+    #
+    # Represents a field of embed.
+    class Field < Discorb::Embed::Entry
+      #
+      # Initialize a new Field object.
+      #
+      # @param [String] name The name of field.
+      # @param [String] value The value of field.
+      # @param [Boolean] inline Whether the field is inline.
+      def initialize: (String name, String value, ?inline: bool) -> void
+
+      #
+      # Convert field to hash.
+      #
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure
+      #   Offical Discord API Docs
+      # @return [Hash] Converted field.
+      %a{pure}
+      def to_hash: -> Discorb::json
+
+      # @return [String] The name of field.
+      attr_accessor name: String
+
+      # @return [String] The value of field.
+      attr_accessor value: String
+
+      # @return [Boolean] Whether the field is inline.
+      attr_accessor inline: bool
+    end
+
+    #
+    # Represents an image of embed.
+    class Image < Discorb::Embed::Entry
+      #
+      # Initialize a new Image object.
+      #
+      # @param [String] url URL of image.
+      def initialize: (String url) -> void
+
+      #
+      # Convert image to hash for sending.
+      #
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure
+      #   Offical Discord API Docs
+      # @return [Hash] Converted image.
+      %a{pure}
+      def to_hash: -> Discorb::json
+
+      # @return [String] The url of image.
+      attr_accessor url: String
+
+      # @return [String] The proxy url of image.
+      # @return [nil] The Image object wasn't created from gateway.
+      attr_reader proxy_url: String?
+
+      # @return [Integer] The height of image.
+      # @return [nil] The Image object wasn't created from gateway.
+      attr_reader height: Integer?
+
+      # @return [Integer] The width of image.
+      # @return [nil] The Image object wasn't created from gateway.
+      attr_reader width: Integer?
+    end
+
+    #
+    # Represents a thumbnail of embed.
+    class Thumbnail < Discorb::Embed::Entry
+      #
+      # Initialize a new Thumbnail object.
+      #
+      # @param [String] url URL of thumbnail.
+      def initialize: (String url) -> void
+
+      #
+      # Convert thumbnail to hash for sending.
+      #
+      # @see https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure
+      #   Offical Discord API Docs
+      # @return [Hash] Converted thumbnail.
+      %a{pure}
+      def to_hash: -> Discorb::json
+
+      # @return [String] The url of thumbnail.
+      attr_accessor url: String
+
+      # @return [String] The proxy url of thumbnail.
+      # @return [nil] The Thumbnail object wasn't created from gateway.
+      attr_reader proxy_url: String?
+
+      # @return [Integer] The height of thumbnail.
+      # @return [nil] The Thumbnail object wasn't created from gateway.
+      attr_reader height: Integer?
+
+      # @return [Integer] The width of thumbnail.
+      # @return [nil] The Thumbnail object wasn't created from gateway.
+      attr_reader width: Integer?
+    end
+
+    #
+    # Represents a video of embed.
+    class Video < Discorb::Embed::Entry
+      #
+      # Initialize a new Video object.
+      # @private
+      #
+      # @param [Hash] data The data of video.
+      def initialize: (Discorb::json data) -> void
+
+      # @return [String] The url of video.
+      attr_reader url: String
+
+      # @return [String] The proxy url of video.
+      attr_reader proxy_url: String
+
+      # @return [Integer] The height of video.
+      attr_reader height: Integer
+
+      # @return [Integer] The width of video.
+      attr_reader width: Integer
+    end
+
+    #
+    # Represents a provider of embed.
+    class Provider < Discorb::Embed::Entry
+      #
+      # Initialize a new Provider object.
+      # @private
+      #
+      # @param [Hash] data The data of provider.
+      def initialize: (Discorb::json data) -> void
+
+      # @return [String] The name of provider.
+      attr_reader name: String
+
+      # @return [String] The url of provider.
+      attr_reader url: String
+    end
+  end
+end

data/sig/discorb/emoji.rbs

@@ -0,0 +1,14 @@
+module Discorb
+  type emoji = Discorb::Emoji | Discorb::PartialEmoji
+
+  # Represents a Discord emoji.
+  # @abstract
+  class Emoji
+    def eql?: (untyped other) -> bool
+
+    def ==: (untyped other) -> untyped
+
+    %a{pure}
+    def inspect: -> String
+  end
+end

data/sig/discorb/error.rbs

@@ -0,0 +1,73 @@
+module Discorb
+  #
+  # Error class for Discorb.
+  # @abstract
+  class DiscorbError < StandardError
+    def enumerate_errors: (untyped hash) -> untyped
+
+    def _recr_items: (untyped key, untyped item, untyped res) -> untyped
+  end
+
+  #
+  # Represents a HTTP error.
+  # @abstract
+  class HTTPError < Discorb::DiscorbError
+    #
+    # Initialize a new instance of the HTTPError class.
+    # @private
+    def initialize: (untyped resp, untyped data) -> void
+
+    # @return [String] the JSON response code.
+    # @see https://discord.com/developers/docs/topics/opcodes-and-status-codes#json-json-error-codes
+    attr_reader code: String
+
+    # @return [Net::HTTPResponse] the HTTP response.
+    attr_reader response: Net::HTTPResponse
+  end
+
+  #
+  # Represents a 400 error.
+  class BadRequestError < Discorb::HTTPError
+    #
+    # Initialize a new instance of the BadRequestError class.
+    # @private
+    def initialize: (untyped resp, untyped data) -> void
+  end
+
+  #
+  # Represents a 401 error.
+  class UnauthorizedError < Discorb::HTTPError
+  end
+
+  #
+  # Represents a 403 error.
+  class ForbiddenError < Discorb::HTTPError
+  end
+
+  #
+  # Represents a 404 error.
+  class NotFoundError < Discorb::HTTPError
+  end
+
+  #
+  # Represents a error because of a cloudflare ban.
+  class CloudFlareBanError < Discorb::HTTPError
+    def initialize: (untyped _resp, untyped client) -> void
+  end
+
+  #
+  # Represents a error in client-side.
+  class ClientError < Discorb::DiscorbError
+  end
+
+  #
+  # Represents a timeout error.
+  class TimeoutError < Discorb::DiscorbError
+  end
+
+  #
+  # Represents a warning.
+  class NotSupportedWarning < Discorb::DiscorbError
+    def initialize: (untyped message) -> void
+  end
+end

data/sig/discorb/event_handler.rbs

@@ -0,0 +1,28 @@
+module Discorb
+  #
+  # Represents a event handler.
+  # This class shouldn't be instantiated directly.
+  # Use {Client#on} instead.
+  class EventHandler
+    def initialize: (untyped block, Symbol? id, untyped metadata) -> void
+
+    %a{pure}
+    def inspect: -> String
+
+    #
+    # Calls the block associated with the event.
+    def call: (*untyped, **untyped) ?{ (*untyped) -> untyped } -> untyped
+
+    # @return [Proc] the block to be called.
+    attr_reader block: ^(*untyped) -> void
+
+    # @return [Symbol] the event id.
+    attr_reader id: Symbol?
+
+    # @return [Hash] the event metadata.
+    attr_reader metadata: ::Hash[untyped, untyped]
+
+    # @return [Boolean] whether the event is once or not.
+    attr_reader once: bool
+  end
+end