topgg-api-types 0.0.1

package/dist/v1/validators.d.ts

@@ -0,0 +1,687 @@
+import * as z from "zod/mini";
+
+//#region src/v1/validators.d.ts
+
+/**
+ * The type of a webhook event. This is used to identify the type of the event that is being delivered to your webhook endpoint.
+ *
+ * Not all webhook events are allowed to be set by an integration - use the `IntegrationSupportedWebhookScopesSchema` to find out which events you can subscribe to as an integration.
+ */
+declare const WebhookEventTypeSchema: z.ZodMiniEnum<{
+  "webhook.test": "webhook.test";
+  "integration.create": "integration.create";
+  "integration.delete": "integration.delete";
+  "vote.create": "vote.create";
+}>;
+/**
+ * The type of a project helps top.gg synchronize features.
+ * For example, a discord bot may have a support server, but this would not make any sense for a discord server.
+ *
+ * You can use this to further find out the specificity of the project.
+ */
+declare const ProjectTypeSchema: z.ZodMiniEnum<{
+  bot: "bot";
+  server: "server";
+  game: "game";
+}>;
+/**
+ * A Platform is used to identify where the corresponding ID links towards.
+ */
+declare const ProjectPlatformTypeSchema: z.ZodMiniEnum<{
+  discord: "discord";
+  roblox: "roblox";
+}>;
+/**
+ * A User Source is an enum that represents a user account from an external platform that is linked to a Top.gg user account.
+ * Each source has a unique identifer type that we might validate against.
+ *
+ * If none is passed to any endpoint that accepts a source parameter, it will default to topgg.
+ */
+declare const UserSourceSchema: z.ZodMiniEnum<{
+  discord: "discord";
+  topgg: "topgg";
+}>;
+/**
+ * Webhook scopes that are supported for integrations.
+ */
+declare const IntegrationSupportedWebhookScopesSchema: z.ZodMiniEnum<{
+  "webhook.test": "webhook.test";
+  "vote.create": "vote.create";
+}>;
+/**
+ * All error responses follow the [`application/problem+json`](https://datatracker.ietf.org/doc/html/rfc7807) specification.
+ */
+declare const ErrorSchema: z.ZodMiniObject<{
+  type: z.ZodMiniString<string>;
+  title: z.ZodMiniString<string>;
+  status: z.ZodMiniNumber<number>;
+  detail: z.ZodMiniString<string>;
+}, z.core.$strip>;
+/**
+ * Represents a user on Top.gg.
+ */
+declare const UserSchema: z.ZodMiniObject<{
+  /**
+   * The user's Top.gg ID.
+   */
+  id: z.ZodMiniString<string>;
+  /**
+   * The user's platform ID (e.g., Discord ID).
+   */
+  platform_id: z.ZodMiniString<string>;
+  /**
+   * The user's username.
+   */
+  name: z.ZodMiniString<string>;
+  /**
+   * The URL of the user's avatar.
+   */
+  avatar_url: z.ZodMiniURL;
+}, z.core.$strip>;
+/**
+ * Base project information shared across all project-related responses.
+ */
+declare const BaseProjectSchema: z.ZodMiniObject<{
+  /**
+   * The project's Top.gg ID.
+   */
+  id: z.ZodMiniString<string>;
+  /**
+   * The platform the project is on (e.g., "discord").
+   */
+  platform: z.ZodMiniEnum<{
+    discord: "discord";
+    roblox: "roblox";
+  }>;
+  /**
+   * The platform-specific ID of the project (e.g., Discord Bot ID).
+   */
+  platform_id: z.ZodMiniString<string>;
+  /**
+   * The type of project (e.g., "bot").
+   */
+  type: z.ZodMiniEnum<{
+    bot: "bot";
+    server: "server";
+    game: "game";
+  }>;
+}, z.core.$strip>;
+/**
+ * Represents a vote on Top.gg.
+ */
+declare const VoteSchema: z.ZodMiniObject<{
+  /**
+   * The Top.gg ID of the user who voted.
+   */
+  user_id: z.ZodMiniString<string>;
+  /**
+   * The user's ID on the project's platform (e.g., Discord ID).
+   */
+  platform_id: z.ZodMiniString<string>;
+  /**
+   * The amount of votes this vote counted for.
+   */
+  weight: z.ZodMiniNumber<number>;
+  /**
+   * The timestamp of when the user voted.
+   */
+  created_at: z.iso.ZodMiniISODate;
+  /**
+   * The timestamp of when the vote expires (i.e., when the user can vote again).
+   * This is typically 12 hours after the `created_at` timestamp, but may vary based on the user's voting history and other factors.
+   */
+  expires_at: z.iso.ZodMiniISODate;
+}, z.core.$strip>;
+/**
+ * Represents a vote for a specific project.
+ */
+declare const ProjectVoteSchema: z.ZodMiniObject<{
+  /**
+   * The Top.gg ID of the user who voted.
+   */
+  user_id: z.ZodMiniString<string>;
+  /**
+   * The user's ID on the project's platform (e.g., Discord ID).
+   */
+  platform_id: z.ZodMiniString<string>;
+  /**
+   * The amount of votes this vote counted for.
+   */
+  weight: z.ZodMiniNumber<number>;
+  /**
+   * The timestamp of when the user voted.
+   */
+  created_at: z.iso.ZodMiniISODate;
+  /**
+   * The timestamp of when the vote expires (i.e., when the user can vote again).
+   * This is typically 12 hours after the `created_at` timestamp, but may vary based on the user's voting history and other factors.
+   */
+  expires_at: z.iso.ZodMiniISODate;
+}, z.core.$strip>;
+declare const WebhookPayloadBaseSchema: <T extends z.infer<typeof WebhookEventTypeSchema>, Data extends z.ZodMiniObject>(type: T, data: Data) => z.ZodMiniObject<{
+  type: z.ZodMiniLiteral<T>;
+  data: Data;
+}, z.core.$strip>;
+/**
+ * Data included when an integration connection is created.
+ */
+declare const IntegrationCreateDataSchema: z.ZodMiniObject<{
+  /**
+   * The unique identifier for this integration connection.
+   */
+  connection_id: z.ZodMiniString<string>;
+  /**
+   * The webhook secret used to verify webhook requests from Top.gg for this connection.
+   */
+  webhook_secret: z.ZodMiniString<string>;
+  /**
+   * The project this integration is connected to.
+   */
+  project: z.ZodMiniObject<{
+    /**
+     * The project's Top.gg ID.
+     */
+    id: z.ZodMiniString<string>;
+    /**
+     * The platform the project is on (e.g., "discord").
+     */
+    platform: z.ZodMiniEnum<{
+      discord: "discord";
+      roblox: "roblox";
+    }>;
+    /**
+     * The platform-specific ID of the project (e.g., Discord Bot ID).
+     */
+    platform_id: z.ZodMiniString<string>;
+    /**
+     * The type of project (e.g., "bot").
+     */
+    type: z.ZodMiniEnum<{
+      bot: "bot";
+      server: "server";
+      game: "game";
+    }>;
+  }, z.core.$strip>;
+  /**
+   * The user who created this integration connection.
+   */
+  user: z.ZodMiniObject<{
+    /**
+     * The user's Top.gg ID.
+     */
+    id: z.ZodMiniString<string>;
+    /**
+     * The user's platform ID (e.g., Discord ID).
+     */
+    platform_id: z.ZodMiniString<string>;
+    /**
+     * The user's username.
+     */
+    name: z.ZodMiniString<string>;
+    /**
+     * The URL of the user's avatar.
+     */
+    avatar_url: z.ZodMiniURL;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * The payload delivered to your webhook endpoint when an integration connection is created.
+ * This will be sent if a user clicks "Connect" for your integration on the dashboard.
+ *
+ * @see https://docs.top.gg/docs/API/v1/integrations#2-topgg-sends-integrationcreate
+ */
+declare const IntegrationCreateWebhookPayloadSchema: z.ZodMiniObject<{
+  type: z.ZodMiniLiteral<"integration.create">;
+  data: z.ZodMiniObject<{
+    /**
+     * The unique identifier for this integration connection.
+     */
+    connection_id: z.ZodMiniString<string>;
+    /**
+     * The webhook secret used to verify webhook requests from Top.gg for this connection.
+     */
+    webhook_secret: z.ZodMiniString<string>;
+    /**
+     * The project this integration is connected to.
+     */
+    project: z.ZodMiniObject<{
+      /**
+       * The project's Top.gg ID.
+       */
+      id: z.ZodMiniString<string>;
+      /**
+       * The platform the project is on (e.g., "discord").
+       */
+      platform: z.ZodMiniEnum<{
+        discord: "discord";
+        roblox: "roblox";
+      }>;
+      /**
+       * The platform-specific ID of the project (e.g., Discord Bot ID).
+       */
+      platform_id: z.ZodMiniString<string>;
+      /**
+       * The type of project (e.g., "bot").
+       */
+      type: z.ZodMiniEnum<{
+        bot: "bot";
+        server: "server";
+        game: "game";
+      }>;
+    }, z.core.$strip>;
+    /**
+     * The user who created this integration connection.
+     */
+    user: z.ZodMiniObject<{
+      /**
+       * The user's Top.gg ID.
+       */
+      id: z.ZodMiniString<string>;
+      /**
+       * The user's platform ID (e.g., Discord ID).
+       */
+      platform_id: z.ZodMiniString<string>;
+      /**
+       * The user's username.
+       */
+      name: z.ZodMiniString<string>;
+      /**
+       * The URL of the user's avatar.
+       */
+      avatar_url: z.ZodMiniURL;
+    }, z.core.$strip>;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * The response you must return from your webhook endpoint when you receive an `integration.create` event.
+ * This tells Top.gg where to deliver webhook events for this integration connection and which events to deliver.
+ *
+ * @see https://docs.top.gg/docs/API/v1/integrations#3-respond-with-configuration
+ */
+declare const IntegrationCreateResponseSchema: z.ZodMiniObject<{
+  /**
+   * The URL where Top.gg should deliver webhook events for this connection.
+   */
+  webhook_url: z.ZodMiniURL;
+  /**
+   * An array of webhook scopes to subscribe to.
+   *
+   * @see https://docs.top.gg/docs/API/v1/webhooks#supported-scopes
+   */
+  routes: z.ZodMiniArray<z.ZodMiniEnum<{
+    "webhook.test": "webhook.test";
+    "vote.create": "vote.create";
+  }>>;
+}, z.core.$strip>;
+/**
+ * Data included when an integration connection is deleted.
+ */
+declare const IntegrationDeleteDataSchema: z.ZodMiniObject<{
+  /**
+   * The unique identifier for the integration connection that was deleted.
+   */
+  connection_id: z.ZodMiniString<string>;
+}, z.core.$strip>;
+/**
+ * The payload delivered to your webhook endpoint when an integration connection is deleted.
+ */
+declare const IntegrationDeleteWebhookPayloadSchema: z.ZodMiniObject<{
+  type: z.ZodMiniLiteral<"integration.delete">;
+  data: z.ZodMiniObject<{
+    /**
+     * The unique identifier for the integration connection that was deleted.
+     */
+    connection_id: z.ZodMiniString<string>;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * Data included when a vote is created.
+ */
+declare const VoteCreateDataSchema: z.ZodMiniObject<{
+  user_id: z.ZodMiniString<string>;
+  platform_id: z.ZodMiniString<string>;
+  weight: z.ZodMiniNumber<number>;
+  created_at: z.iso.ZodMiniISODate;
+  expires_at: z.iso.ZodMiniISODate;
+  project: z.ZodMiniObject<{
+    /**
+     * The project's Top.gg ID.
+     */
+    id: z.ZodMiniString<string>;
+    /**
+     * The platform the project is on (e.g., "discord").
+     */
+    platform: z.ZodMiniEnum<{
+      discord: "discord";
+      roblox: "roblox";
+    }>;
+    /**
+     * The platform-specific ID of the project (e.g., Discord Bot ID).
+     */
+    platform_id: z.ZodMiniString<string>;
+    /**
+     * The type of project (e.g., "bot").
+     */
+    type: z.ZodMiniEnum<{
+      bot: "bot";
+      server: "server";
+      game: "game";
+    }>;
+  }, z.core.$strip>;
+  user: z.ZodMiniObject<{
+    /**
+     * The user's Top.gg ID.
+     */
+    id: z.ZodMiniString<string>;
+    /**
+     * The user's platform ID (e.g., Discord ID).
+     */
+    platform_id: z.ZodMiniString<string>;
+    /**
+     * The user's username.
+     */
+    name: z.ZodMiniString<string>;
+    /**
+     * The URL of the user's avatar.
+     */
+    avatar_url: z.ZodMiniURL;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * The payload delivered to your webhook endpoint when a user votes for your project and you have subscribed to the `vote.create` event.
+ */
+declare const VoteCreateWebhookPayloadSchema: z.ZodMiniObject<{
+  type: z.ZodMiniLiteral<"vote.create">;
+  data: z.ZodMiniObject<{
+    user_id: z.ZodMiniString<string>;
+    platform_id: z.ZodMiniString<string>;
+    weight: z.ZodMiniNumber<number>;
+    created_at: z.iso.ZodMiniISODate;
+    expires_at: z.iso.ZodMiniISODate;
+    project: z.ZodMiniObject<{
+      /**
+       * The project's Top.gg ID.
+       */
+      id: z.ZodMiniString<string>;
+      /**
+       * The platform the project is on (e.g., "discord").
+       */
+      platform: z.ZodMiniEnum<{
+        discord: "discord";
+        roblox: "roblox";
+      }>;
+      /**
+       * The platform-specific ID of the project (e.g., Discord Bot ID).
+       */
+      platform_id: z.ZodMiniString<string>;
+      /**
+       * The type of project (e.g., "bot").
+       */
+      type: z.ZodMiniEnum<{
+        bot: "bot";
+        server: "server";
+        game: "game";
+      }>;
+    }, z.core.$strip>;
+    user: z.ZodMiniObject<{
+      /**
+       * The user's Top.gg ID.
+       */
+      id: z.ZodMiniString<string>;
+      /**
+       * The user's platform ID (e.g., Discord ID).
+       */
+      platform_id: z.ZodMiniString<string>;
+      /**
+       * The user's username.
+       */
+      name: z.ZodMiniString<string>;
+      /**
+       * The URL of the user's avatar.
+       */
+      avatar_url: z.ZodMiniURL;
+    }, z.core.$strip>;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * Data included in a webhook test event.
+ */
+declare const WebhookTestDataSchema: z.ZodMiniObject<{
+  /**
+   * A test user.
+   */
+  user: z.ZodMiniObject<{
+    /**
+     * The user's Top.gg ID.
+     */
+    id: z.ZodMiniString<string>;
+    /**
+     * The user's platform ID (e.g., Discord ID).
+     */
+    platform_id: z.ZodMiniString<string>;
+    /**
+     * The user's username.
+     */
+    name: z.ZodMiniString<string>;
+    /**
+     * The URL of the user's avatar.
+     */
+    avatar_url: z.ZodMiniURL;
+  }, z.core.$strip>;
+  /**
+   * A test project.
+   */
+  project: z.ZodMiniObject<{
+    /**
+     * The project's Top.gg ID.
+     */
+    id: z.ZodMiniString<string>;
+    /**
+     * The platform the project is on (e.g., "discord").
+     */
+    platform: z.ZodMiniEnum<{
+      discord: "discord";
+      roblox: "roblox";
+    }>;
+    /**
+     * The platform-specific ID of the project (e.g., Discord Bot ID).
+     */
+    platform_id: z.ZodMiniString<string>;
+    /**
+     * The type of project (e.g., "bot").
+     */
+    type: z.ZodMiniEnum<{
+      bot: "bot";
+      server: "server";
+      game: "game";
+    }>;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * The payload delivered to your webhook endpoint when you send a test webhook from the dashboard or via the API.
+ */
+declare const WebhookTestWebhookPayloadSchema: z.ZodMiniObject<{
+  type: z.ZodMiniLiteral<"webhook.test">;
+  data: z.ZodMiniObject<{
+    /**
+     * A test user.
+     */
+    user: z.ZodMiniObject<{
+      /**
+       * The user's Top.gg ID.
+       */
+      id: z.ZodMiniString<string>;
+      /**
+       * The user's platform ID (e.g., Discord ID).
+       */
+      platform_id: z.ZodMiniString<string>;
+      /**
+       * The user's username.
+       */
+      name: z.ZodMiniString<string>;
+      /**
+       * The URL of the user's avatar.
+       */
+      avatar_url: z.ZodMiniURL;
+    }, z.core.$strip>;
+    /**
+     * A test project.
+     */
+    project: z.ZodMiniObject<{
+      /**
+       * The project's Top.gg ID.
+       */
+      id: z.ZodMiniString<string>;
+      /**
+       * The platform the project is on (e.g., "discord").
+       */
+      platform: z.ZodMiniEnum<{
+        discord: "discord";
+        roblox: "roblox";
+      }>;
+      /**
+       * The platform-specific ID of the project (e.g., Discord Bot ID).
+       */
+      platform_id: z.ZodMiniString<string>;
+      /**
+       * The type of project (e.g., "bot").
+       */
+      type: z.ZodMiniEnum<{
+        bot: "bot";
+        server: "server";
+        game: "game";
+      }>;
+    }, z.core.$strip>;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * Response schema for getting the authenticated project.
+ *
+ * - GET `/v1/projects/@me`
+ *
+ * @see https://docs.top.gg/docs/API/v1/projects#get-current-project
+ */
+declare const GetProjectResponseSchema: z.ZodMiniObject<{
+  id: z.ZodMiniString<string>;
+  platform: z.ZodMiniEnum<{
+    discord: "discord";
+    roblox: "roblox";
+  }>;
+  platform_id: z.ZodMiniString<string>;
+  type: z.ZodMiniEnum<{
+    bot: "bot";
+    server: "server";
+    game: "game";
+  }>;
+  name: z.ZodMiniString<string>;
+  headline: z.ZodMiniString<string>;
+  tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+  votes: z.ZodMiniNumber<number>;
+  votes_total: z.ZodMiniNumber<number>;
+  review_score: z.ZodMiniNumber<number>;
+  review_count: z.ZodMiniNumber<number>;
+}, z.core.$strip>;
+/**
+ * Query parameters for getting project votes.
+ *
+ * - GET `/v1/projects/@me/votes`
+ *
+ * Either `cursor` or `startDate` must be provided.
+ *
+ * @see https://docs.top.gg/docs/API/v1/projects/#get-votes
+ */
+declare const GetProjectVotesQuerySchema: z.ZodMiniObject<{
+  /**
+   * Pagination cursor for fetching the next page of votes. if provided, `startDate` is ignored.
+   *
+   * From the previous response.
+   */
+  cursor: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  /**
+   * The start date for fetching votes. Only votes created after this date will be returned. Required if `cursor` is not provided.
+   *
+   * Maximum 1 year in the past.
+   *
+   * ISO 8601 date string.
+   */
+  startDate: z.ZodMiniOptional<z.iso.ZodMiniISODate>;
+}, z.core.$strip>;
+/**
+ * Response schema for the Get Project Votes endpoint.
+ *
+ * - GET `/v1/projects/@me/votes`
+ *
+ * @see https://docs.top.gg/docs/API/v1/projects/#get-votes
+ */
+declare const GetProjectVotesResponseSchema: z.ZodMiniObject<{
+  /**
+   * Cursor for fetching the next page of votes.
+   */
+  cursor: z.ZodMiniString<string>;
+  /**
+   * An array of votes for the project.
+   */
+  data: z.ZodMiniArray<z.ZodMiniObject<{
+    /**
+     * The Top.gg ID of the user who voted.
+     */
+    user_id: z.ZodMiniString<string>;
+    /**
+     * The user's ID on the project's platform (e.g., Discord ID).
+     */
+    platform_id: z.ZodMiniString<string>;
+    /**
+     * The amount of votes this vote counted for.
+     */
+    weight: z.ZodMiniNumber<number>;
+    /**
+     * The timestamp of when the user voted.
+     */
+    created_at: z.iso.ZodMiniISODate;
+    /**
+     * The timestamp of when the vote expires (i.e., when the user can vote again).
+     * This is typically 12 hours after the `created_at` timestamp, but may vary based on the user's voting history and other factors.
+     */
+    expires_at: z.iso.ZodMiniISODate;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Query parameters for getting vote status by user.
+ *
+ * - GET `/v1/projects/@me/votes/:user_id`
+ *
+ * @see https://docs.top.gg/docs/API/v1/projects/#get-vote-status-by-user
+ */
+declare const GetVoteStatusByUserQuerySchema: z.ZodMiniObject<{
+  /**
+   * The source of the user ID. Defaults to "topgg".
+   */
+  source: z.ZodMiniOptional<z.ZodMiniEnum<{
+    discord: "discord";
+    topgg: "topgg";
+  }>>;
+}, z.core.$strip>;
+/**
+ * Response schema for the Get Vote Status By User endpoint.
+ *
+ * - GET `/v1/projects/@me/votes/:user_id`
+ *
+ * @see https://docs.top.gg/docs/API/v1/projects/#get-vote-status-by-user
+ */
+declare const GetVoteStatusByUserResponseSchema: z.ZodMiniObject<{
+  /**
+   * The timestamp of when the user last voted.
+   */
+  created_at: z.iso.ZodMiniISODate;
+  /**
+   * The timestamp of when the user's vote expires (i.e., when they can vote again).
+   */
+  expires_at: z.iso.ZodMiniISODate;
+  /**
+   * The amount of votes this vote counted for.
+   */
+  weight: z.ZodMiniNumber<number>;
+}, z.core.$strip>;
+//#endregion
+export { BaseProjectSchema, ErrorSchema, GetProjectResponseSchema, GetProjectVotesQuerySchema, GetProjectVotesResponseSchema, GetVoteStatusByUserQuerySchema, GetVoteStatusByUserResponseSchema, IntegrationCreateDataSchema, IntegrationCreateResponseSchema, IntegrationCreateWebhookPayloadSchema, IntegrationDeleteDataSchema, IntegrationDeleteWebhookPayloadSchema, IntegrationSupportedWebhookScopesSchema, ProjectPlatformTypeSchema, ProjectTypeSchema, ProjectVoteSchema, UserSchema, UserSourceSchema, VoteCreateDataSchema, VoteCreateWebhookPayloadSchema, VoteSchema, WebhookEventTypeSchema, WebhookPayloadBaseSchema, WebhookTestDataSchema, WebhookTestWebhookPayloadSchema };
+//# sourceMappingURL=validators.d.ts.map