topgg-api-types 0.0.1

package/dist/v0/validators.d.ts

@@ -0,0 +1,605 @@
+import * as z from "zod/mini";
+
+//#region src/v0/validators.d.ts
+
+/**
+ * The type of a webhook event.
+ */
+declare const WebhookEventTypeSchema: z.ZodMiniEnum<{
+  upvote: "upvote";
+  test: "test";
+}>;
+/**
+ * Webhook payload for bot votes (deprecated).
+ *
+ * @deprecated Use `v1` types instead.
+ */
+declare const BotWebhookPayloadSchema: z.ZodMiniObject<{
+  /**
+   * Discord ID of the bot that received a vote.
+   */
+  bot: z.ZodMiniString<string>;
+  /**
+   * Discord ID of the user that voted.
+   */
+  user: z.ZodMiniString<string>;
+  /**
+   * The type of the vote (should always be "upvote" except when using the test button it's "test").
+   */
+  type: z.ZodMiniEnum<{
+    upvote: "upvote";
+    test: "test";
+  }>;
+  /**
+   * Whether the weekend multiplier is in effect, meaning users votes count as two.
+   */
+  isWeekend: z.ZodMiniBoolean<boolean>;
+  /**
+   * Query string params found on the /bot/:ID/vote page.
+   *
+   * @example
+   * "?a=1&b=2&c=3"
+   */
+  query: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+/**
+ * Webhook payload for server votes (deprecated).
+ *
+ * @deprecated Use `v1` types instead.
+ */
+declare const ServerWebhookPayloadSchema: z.ZodMiniObject<{
+  /**
+   * Discord ID of the server that received a vote.
+   */
+  guild: z.ZodMiniString<string>;
+  /**
+   * Discord ID of the user that voted.
+   */
+  user: z.ZodMiniString<string>;
+  /**
+   * The type of the vote (should always be "upvote" except when using the test button it's "test").
+   */
+  type: z.ZodMiniEnum<{
+    upvote: "upvote";
+    test: "test";
+  }>;
+  /**
+   * Whether the weekend multiplier is in effect, meaning users votes count as two.
+   */
+  query: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+/**
+ * A bot listed on Top.gg.
+ */
+declare const BotSchema: z.ZodMiniObject<{
+  /**
+   * The Discord ID of the bot
+   */
+  id: z.ZodMiniString<string>;
+  /**
+   * The username of the bot
+   */
+  username: z.ZodMiniString<string>;
+  /**
+   * The discriminator of the bot (legacy Discord feature)
+   */
+  discriminator: z.ZodMiniString<string>;
+  /**
+   * The avatar hash of the bot's avatar
+   */
+  avatar: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The cdn hash of the bot's avatar if the bot has none
+   */
+  defAvatar: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The command prefix of the bot
+   */
+  prefix: z.ZodMiniString<string>;
+  /**
+   * The short description of the bot
+   */
+  shortdesc: z.ZodMiniString<string>;
+  /**
+   * The detailed long description of the bot
+   */
+  longdesc: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * Array of tags associated with the bot
+   */
+  tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+  /**
+   * The official website URL of the bot
+   */
+  website: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The support server URL for the bot
+   */
+  support: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The GitHub repository URL of the bot
+   */
+  github: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * Array of snowflake identifiers of the bot owners
+   */
+  owners: z.ZodMiniArray<z.ZodMiniString<string>>;
+  /**
+   * Array of guild snowflake identifiers where the bot is present
+   */
+  guilds: z.ZodMiniArray<z.ZodMiniString<string>>;
+  /**
+   * The OAuth2 invite URL of the bot
+   */
+  invite: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The date when the bot was approved on Top.gg in ISO 8601 format
+   */
+  date: z.iso.ZodMiniISODate;
+  /**
+   * The amount of servers the bot has according to posted stats.
+   */
+  server_count: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+  /**
+   * The amount of shards the bot has according to posted stats.
+   */
+  shard_count: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+  /**
+   * Whether the bot is certified on Top.gg
+   */
+  certifiedBot: z.ZodMiniBoolean<boolean>;
+  /**
+   * The vanity URL of the bot on Top.gg
+   */
+  vanity: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The amount of upvotes the bot has
+   */
+  points: z.ZodMiniNumber<number>;
+  /**
+   * The amount of upvotes the bot has this month
+   */
+  monthlyPoints: z.ZodMiniNumber<number>;
+  /**
+   * The guild id for the donatebot setup
+   */
+  donatebotguildid: z.ZodMiniString<string>;
+}, z.core.$strip>;
+/**
+ * Query parameters for searching bots on Top.gg.
+ *
+ * @see https://docs.top.gg/docs/API/v0/bot#search-bots
+ */
+declare const GetSearchBotsQuerySchema: z.ZodMiniObject<{
+  /**
+   * The amount of bots to return.
+   *
+   * @minimum 1
+   * @maximum 500
+   * @default 50
+   */
+  limit: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+  /**
+   * The amount of bots to skip (for pagination).
+   *
+   * @minimum 0
+   * @default 0
+   */
+  offset: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+  /**
+   * The field to sort the bots by. Prefix with `-` for descending order.
+   *
+   * There is no documented default.
+   */
+  sort: z.ZodMiniString<string>;
+  /**
+   * Comma separated list of fields to include in the response. If not provided, all fields will be included.
+   */
+  fields: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+/**
+ * Response for searching bots on Top.gg.
+ */
+declare const GetSearchBotsResponseSchema: z.ZodMiniObject<{
+  /**
+   * The array of bots that match the search query.
+   */
+  results: z.ZodMiniArray<z.ZodMiniObject<{
+    /**
+     * The Discord ID of the bot
+     */
+    id: z.ZodMiniString<string>;
+    /**
+     * The username of the bot
+     */
+    username: z.ZodMiniString<string>;
+    /**
+     * The discriminator of the bot (legacy Discord feature)
+     */
+    discriminator: z.ZodMiniString<string>;
+    /**
+     * The avatar hash of the bot's avatar
+     */
+    avatar: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * The cdn hash of the bot's avatar if the bot has none
+     */
+    defAvatar: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * The command prefix of the bot
+     */
+    prefix: z.ZodMiniString<string>;
+    /**
+     * The short description of the bot
+     */
+    shortdesc: z.ZodMiniString<string>;
+    /**
+     * The detailed long description of the bot
+     */
+    longdesc: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Array of tags associated with the bot
+     */
+    tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+    /**
+     * The official website URL of the bot
+     */
+    website: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * The support server URL for the bot
+     */
+    support: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * The GitHub repository URL of the bot
+     */
+    github: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Array of snowflake identifiers of the bot owners
+     */
+    owners: z.ZodMiniArray<z.ZodMiniString<string>>;
+    /**
+     * Array of guild snowflake identifiers where the bot is present
+     */
+    guilds: z.ZodMiniArray<z.ZodMiniString<string>>;
+    /**
+     * The OAuth2 invite URL of the bot
+     */
+    invite: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * The date when the bot was approved on Top.gg in ISO 8601 format
+     */
+    date: z.iso.ZodMiniISODate;
+    /**
+     * The amount of servers the bot has according to posted stats.
+     */
+    server_count: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+    /**
+     * The amount of shards the bot has according to posted stats.
+     */
+    shard_count: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+    /**
+     * Whether the bot is certified on Top.gg
+     */
+    certifiedBot: z.ZodMiniBoolean<boolean>;
+    /**
+     * The vanity URL of the bot on Top.gg
+     */
+    vanity: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * The amount of upvotes the bot has
+     */
+    points: z.ZodMiniNumber<number>;
+    /**
+     * The amount of upvotes the bot has this month
+     */
+    monthlyPoints: z.ZodMiniNumber<number>;
+    /**
+     * The guild id for the donatebot setup
+     */
+    donatebotguildid: z.ZodMiniString<string>;
+  }, z.core.$strip>>;
+  /**
+   * The total number of bots that match the search query.
+   */
+  total: z.ZodMiniNumber<number>;
+  /**
+   * The limit used in the query.
+   */
+  limit: z.ZodMiniNumber<number>;
+  /**
+   * The amount of bots skipped (for pagination).
+   */
+  offset: z.ZodMiniNumber<number>;
+  /**
+   * The amount of items in the current page of results.
+   */
+  count: z.ZodMiniNumber<number>;
+}, z.core.$strip>;
+/**
+ * Response for getting a bot.
+ *
+ * - GET `/bots/:bot_id`
+ */
+declare const GetBotResponseSchema: z.ZodMiniObject<{
+  /**
+   * The Discord ID of the bot
+   */
+  id: z.ZodMiniString<string>;
+  /**
+   * The username of the bot
+   */
+  username: z.ZodMiniString<string>;
+  /**
+   * The discriminator of the bot (legacy Discord feature)
+   */
+  discriminator: z.ZodMiniString<string>;
+  /**
+   * The avatar hash of the bot's avatar
+   */
+  avatar: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The cdn hash of the bot's avatar if the bot has none
+   */
+  defAvatar: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The command prefix of the bot
+   */
+  prefix: z.ZodMiniString<string>;
+  /**
+   * The short description of the bot
+   */
+  shortdesc: z.ZodMiniString<string>;
+  /**
+   * The detailed long description of the bot
+   */
+  longdesc: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * Array of tags associated with the bot
+   */
+  tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+  /**
+   * The official website URL of the bot
+   */
+  website: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The support server URL for the bot
+   */
+  support: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The GitHub repository URL of the bot
+   */
+  github: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * Array of snowflake identifiers of the bot owners
+   */
+  owners: z.ZodMiniArray<z.ZodMiniString<string>>;
+  /**
+   * Array of guild snowflake identifiers where the bot is present
+   */
+  guilds: z.ZodMiniArray<z.ZodMiniString<string>>;
+  /**
+   * The OAuth2 invite URL of the bot
+   */
+  invite: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The date when the bot was approved on Top.gg in ISO 8601 format
+   */
+  date: z.iso.ZodMiniISODate;
+  /**
+   * The amount of servers the bot has according to posted stats.
+   */
+  server_count: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+  /**
+   * The amount of shards the bot has according to posted stats.
+   */
+  shard_count: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+  /**
+   * Whether the bot is certified on Top.gg
+   */
+  certifiedBot: z.ZodMiniBoolean<boolean>;
+  /**
+   * The vanity URL of the bot on Top.gg
+   */
+  vanity: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The amount of upvotes the bot has
+   */
+  points: z.ZodMiniNumber<number>;
+  /**
+   * The amount of upvotes the bot has this month
+   */
+  monthlyPoints: z.ZodMiniNumber<number>;
+  /**
+   * The guild id for the donatebot setup
+   */
+  donatebotguildid: z.ZodMiniString<string>;
+}, z.core.$strip>;
+/**
+ * A bot voter.
+ */
+declare const BotVoterSchema: z.ZodMiniObject<{
+  /**
+   * The Discord ID of the user that voted.
+   */
+  id: z.ZodMiniString<string>;
+  /**
+   * The username of the user that voted, including discriminator (e.g., "wumpus#0000").
+   */
+  username: z.ZodMiniString<string>;
+  /**
+   * The avatar hash of the user that voted.
+   */
+  avatar: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+/**
+ * Gets the last 1000 voters for your bot.
+ *
+ * - GET `/bots/:bot_id/votes`
+ */
+declare const GetLast1000BotVotesResponseSchema: z.ZodMiniArray<z.ZodMiniObject<{
+  /**
+   * The Discord ID of the user that voted.
+   */
+  id: z.ZodMiniString<string>;
+  /**
+   * The username of the user that voted, including discriminator (e.g., "wumpus#0000").
+   */
+  username: z.ZodMiniString<string>;
+  /**
+   * The avatar hash of the user that voted.
+   */
+  avatar: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strip>>;
+/**
+ * Specific stats about a bot.
+ *
+ * - GET `/bots/:bot_id/stats`
+ */
+declare const GetBotStatsResponseSchema: z.ZodMiniObject<{
+  /**
+   * The amount of servers the bot is in
+   */
+  server_count: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+  /**
+   * The amount of servers the bot is in per shard. Always present but can be empty.
+   */
+  shards: z.ZodMiniArray<z.ZodMiniNumber<number>>;
+  /**
+   * The amount of shards a bot has according to posted stats.
+   */
+  shard_count: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+}, z.core.$strip>;
+/**
+ * Query parameters for checking whether or not a user has voted for your bot.
+ *
+ * - GET `/bots/:bot_id/check`
+ */
+declare const GetUserVoteCheckQuerySchema: z.ZodMiniObject<{
+  /**
+   * The Discord ID of the user to check for a vote.
+   */
+  userId: z.ZodMiniString<string>;
+}, z.core.$strip>;
+/**
+ * Response for checking whether or not a user has voted for your bot.
+ *
+ * - GET `/bots/:bot_id/check`
+ */
+declare const GetUserVoteCheckResponseSchema: z.ZodMiniObject<{
+  /**
+   * 0 if the user has not voted for this bot in the last 12 hours, 1 if they have.
+   */
+  voted: z.ZodMiniXor<readonly [z.ZodMiniLiteral<0>, z.ZodMiniLiteral<1>]>;
+}, z.core.$strip>;
+/**
+ * Request body for posting bot stats.
+ */
+declare const PostBotStatsBodySchema: z.ZodMiniObject<{
+  /**
+   * The amount of servers the bot is in. Required if the bot has less than 100 servers, otherwise optional but recommended.
+   *
+   * If an Array, it acts like shards.
+   */
+  server_count: z.ZodMiniXor<readonly [z.ZodMiniNumber<number>, z.ZodMiniArray<z.ZodMiniNumber<number>>]>;
+  /**
+   * Amount of servers the bot is in per shard.
+   */
+  shards: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniNumber<number>>>;
+  /**
+   * The zero-indexed id of the shard posting. Makes server_count set the shard specific server count.
+   */
+  shard_id: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+  /**
+   * The amount of shards the bot has.
+   */
+  shard_count: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+}, z.core.$strip>;
+/**
+ * A user on Top.gg.
+ *
+ * - GET `/users/:user_id`
+ */
+declare const UserSchema: z.ZodMiniObject<{
+  /**
+   * The Discord ID for this user.
+   */
+  id: z.ZodMiniString<string>;
+  /**
+   * The username of the user, not including discriminator (e.g., "wumpus").
+   */
+  username: z.ZodMiniString<string>;
+  /**
+   * The discriminator of the user (legacy Discord feature, e.g., "0000").
+   */
+  discriminator: z.ZodMiniString<string>;
+  /**
+   * The avatar hash of the user's avatar.
+   */
+  avatar: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The cdn hash of the user's avatar if the user has none.
+   */
+  defAvatar: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The bio of the user. This is a short description that the user can set on their profile. It may be empty or null if the user has not set a bio.
+   *
+   * This is NOT their in-discord bio.
+   */
+  bio: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The banner image URL of the user.
+   */
+  banner: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The social usernames of the user
+   */
+  social: z.ZodMiniObject<{
+    /**
+     * The YouTube channel ID of the user. This is not the full URL, just the channel ID (e.g., "UC_x5XG1OV2P6uZZ5FSM9Ttw").
+     */
+    youtube: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * The Reddit username of the user (e.g., "spez"). This is not the full URL, just the username.
+     */
+    reddit: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * The Twitter username of the user (e.g., "jack"). This is not the full URL, just the username.
+     */
+    twitter: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * The Instagram username of the user (e.g., "instagram"). This is not the full URL, just the username.
+     */
+    instagram: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * The GitHub username of the user (e.g., "torvalds"). This is not the full URL, just the username.
+     */
+    github: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  }, z.core.$strip>;
+  /**
+   * The custom hex color of the user (not guaranteed to be valid hex). This is a color that the user can set on their profile.
+   */
+  color: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The supporter status of the user. This is true if the user has voted for any bot in the last month.
+   */
+  supporter: z.ZodMiniBoolean<boolean>;
+  /**
+   * The certified status of the user.
+   */
+  certifiedDev: z.ZodMiniBoolean<boolean>;
+  /**
+   * The mod status of the user. This is true if the user is a moderator on Top.gg.
+   */
+  mod: z.ZodMiniBoolean<boolean>;
+  /**
+   * The website moderator status of the user. This is true if the user is a website moderator on Top.gg.
+   */
+  webMod: z.ZodMiniBoolean<boolean>;
+  /**
+   * The admin status of the user.
+   */
+  admin: z.ZodMiniBoolean<boolean>;
+}, z.core.$strip>;
+//#endregion
+export { BotSchema, BotVoterSchema, BotWebhookPayloadSchema, GetBotResponseSchema, GetBotStatsResponseSchema, GetLast1000BotVotesResponseSchema, GetSearchBotsQuerySchema, GetSearchBotsResponseSchema, GetUserVoteCheckQuerySchema, GetUserVoteCheckResponseSchema, PostBotStatsBodySchema, ServerWebhookPayloadSchema, UserSchema, WebhookEventTypeSchema };
+//# sourceMappingURL=validators.d.ts.map