topgg-api-types 0.0.1

package/dist/v1/validators.js

@@ -0,0 +1,206 @@
+import { n as SnowflakeSchema, t as ISO8601DateSchema } from "../validators-Mlu16sBg.js";
+import * as z from "zod/mini";
+
+//#region src/v1/validators.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.
+*/
+const WebhookEventTypeSchema = z.enum([
+	"webhook.test",
+	"integration.create",
+	"integration.delete",
+	"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.
+*/
+const ProjectTypeSchema = z.enum([
+	"bot",
+	"server",
+	"game"
+]);
+/**
+* A Platform is used to identify where the corresponding ID links towards.
+*/
+const ProjectPlatformTypeSchema = z.enum(["discord", "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.
+*/
+const UserSourceSchema = z.enum(["discord", "topgg"]);
+/**
+* Webhook scopes that are supported for integrations.
+*/
+const IntegrationSupportedWebhookScopesSchema = z.enum(["webhook.test", "vote.create"]);
+/**
+* All error responses follow the [`application/problem+json`](https://datatracker.ietf.org/doc/html/rfc7807) specification.
+*/
+const ErrorSchema = z.object({
+	type: z.string(),
+	title: z.string(),
+	status: z.number(),
+	detail: z.string()
+});
+/**
+* Represents a user on Top.gg.
+*/
+const UserSchema = z.object({
+	id: SnowflakeSchema,
+	platform_id: SnowflakeSchema,
+	name: z.string(),
+	avatar_url: z.url()
+});
+/**
+* Base project information shared across all project-related responses.
+*/
+const BaseProjectSchema = z.object({
+	id: SnowflakeSchema,
+	platform: ProjectPlatformTypeSchema,
+	platform_id: SnowflakeSchema,
+	type: ProjectTypeSchema
+});
+/**
+* Represents a vote on Top.gg.
+*/
+const VoteSchema = z.object({
+	user_id: SnowflakeSchema,
+	platform_id: SnowflakeSchema,
+	weight: z.number(),
+	created_at: ISO8601DateSchema,
+	expires_at: ISO8601DateSchema
+});
+/**
+* Represents a vote for a specific project.
+*/
+const ProjectVoteSchema = z.clone(VoteSchema);
+const WebhookPayloadBaseSchema = (type, data) => z.object({
+	type: z.literal(type),
+	data
+});
+/**
+* Data included when an integration connection is created.
+*/
+const IntegrationCreateDataSchema = z.object({
+	connection_id: SnowflakeSchema,
+	webhook_secret: z.string().check(z.regex(/^whs_[a-zA-Z0-9]+$/, "Invalid webhook secret")),
+	project: BaseProjectSchema,
+	user: UserSchema
+});
+/**
+* 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
+*/
+const IntegrationCreateWebhookPayloadSchema = WebhookPayloadBaseSchema("integration.create", IntegrationCreateDataSchema);
+/**
+* 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
+*/
+const IntegrationCreateResponseSchema = z.object({
+	webhook_url: z.url(),
+	routes: z.array(IntegrationSupportedWebhookScopesSchema).check(z.refine((arr) => arr.length === new Set(arr).size, "Duplicate webhook scopes are not allowed"))
+});
+/**
+* Data included when an integration connection is deleted.
+*/
+const IntegrationDeleteDataSchema = z.object({ connection_id: SnowflakeSchema });
+/**
+* The payload delivered to your webhook endpoint when an integration connection is deleted.
+*/
+const IntegrationDeleteWebhookPayloadSchema = WebhookPayloadBaseSchema("integration.delete", IntegrationDeleteDataSchema);
+/**
+* Data included when a vote is created.
+*/
+const VoteCreateDataSchema = z.extend(VoteSchema, {
+	project: BaseProjectSchema,
+	user: UserSchema
+});
+/**
+* The payload delivered to your webhook endpoint when a user votes for your project and you have subscribed to the `vote.create` event.
+*/
+const VoteCreateWebhookPayloadSchema = WebhookPayloadBaseSchema("vote.create", VoteCreateDataSchema);
+/**
+* Data included in a webhook test event.
+*/
+const WebhookTestDataSchema = z.object({
+	user: UserSchema,
+	project: BaseProjectSchema
+});
+/**
+* The payload delivered to your webhook endpoint when you send a test webhook from the dashboard or via the API.
+*/
+const WebhookTestWebhookPayloadSchema = WebhookPayloadBaseSchema("webhook.test", WebhookTestDataSchema);
+/**
+* Response schema for getting the authenticated project.
+*
+* - GET `/v1/projects/@me`
+*
+* @see https://docs.top.gg/docs/API/v1/projects#get-current-project
+*/
+const GetProjectResponseSchema = z.extend(BaseProjectSchema, {
+	name: z.string(),
+	headline: z.string(),
+	tags: z.array(z.string()),
+	votes: z.number(),
+	votes_total: z.number(),
+	review_score: z.number(),
+	review_count: z.number()
+});
+/**
+* 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
+*/
+const GetProjectVotesQuerySchema = z.object({
+	cursor: z.optional(z.string()),
+	startDate: z.optional(ISO8601DateSchema)
+}).check(z.refine((data) => data.cursor || data.startDate, "Either cursor or startDate must be provided"));
+/**
+* Response schema for the Get Project Votes endpoint.
+*
+* - GET `/v1/projects/@me/votes`
+*
+* @see https://docs.top.gg/docs/API/v1/projects/#get-votes
+*/
+const GetProjectVotesResponseSchema = z.object({
+	cursor: z.string(),
+	data: z.array(ProjectVoteSchema)
+});
+/**
+* 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
+*/
+const GetVoteStatusByUserQuerySchema = z.object({ source: z.optional(UserSourceSchema) });
+/**
+* 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
+*/
+const GetVoteStatusByUserResponseSchema = z.object({
+	created_at: ISO8601DateSchema,
+	expires_at: ISO8601DateSchema,
+	weight: z.number()
+});
+
+//#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.js.map

package/dist/v1/validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","names":[],"sources":["../../src/v1/validators.ts"],"sourcesContent":["import * as z from \"zod/mini\";\nimport { ISO8601DateSchema, SnowflakeSchema } from \"@utils/validators\";\n\n// # General and Base Schemas\n\n// ## Enums and Constants\n\n/**\n * The type of a webhook event. This is used to identify the type of the event that is being delivered to your webhook endpoint.\n *\n * 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.\n */\nexport const WebhookEventTypeSchema = z.enum([\n  \"webhook.test\",\n  \"integration.create\",\n  \"integration.delete\",\n  \"vote.create\",\n]);\n\n/**\n * The type of a project helps top.gg synchronize features.\n * For example, a discord bot may have a support server, but this would not make any sense for a discord server.\n *\n * You can use this to further find out the specificity of the project.\n */\nexport const ProjectTypeSchema = z.enum([\"bot\", \"server\", \"game\"]);\n\n/**\n * A Platform is used to identify where the corresponding ID links towards.\n */\nexport const ProjectPlatformTypeSchema = z.enum([\"discord\", \"roblox\"]);\n\n/**\n * A User Source is an enum that represents a user account from an external platform that is linked to a Top.gg user account.\n * Each source has a unique identifer type that we might validate against.\n *\n * If none is passed to any endpoint that accepts a source parameter, it will default to topgg.\n */\nexport const UserSourceSchema = z.enum([\"discord\", \"topgg\"]);\n\n/**\n * Webhook scopes that are supported for integrations.\n */\nexport const IntegrationSupportedWebhookScopesSchema = z.enum([\"webhook.test\", \"vote.create\"]);\n\n/**\n * All error responses follow the [`application/problem+json`](https://datatracker.ietf.org/doc/html/rfc7807) specification.\n */\nexport const ErrorSchema = z.object({\n  type: z.string(),\n  title: z.string(),\n  status: z.number(),\n  detail: z.string(),\n});\n\n/**\n * Represents a user on Top.gg.\n */\nexport const UserSchema = z.object({\n  /**\n   * The user's Top.gg ID.\n   */\n  id: SnowflakeSchema,\n  /**\n   * The user's platform ID (e.g., Discord ID).\n   */\n  platform_id: SnowflakeSchema,\n  /**\n   * The user's username.\n   */\n  name: z.string(),\n  /**\n   * The URL of the user's avatar.\n   */\n  avatar_url: z.url(),\n});\n\n/**\n * Base project information shared across all project-related responses.\n */\nexport const BaseProjectSchema = z.object({\n  /**\n   * The project's Top.gg ID.\n   */\n  id: SnowflakeSchema,\n  /**\n   * The platform the project is on (e.g., \"discord\").\n   */\n  platform: ProjectPlatformTypeSchema,\n  /**\n   * The platform-specific ID of the project (e.g., Discord Bot ID).\n   */\n  platform_id: SnowflakeSchema,\n  /**\n   * The type of project (e.g., \"bot\").\n   */\n  type: ProjectTypeSchema,\n});\n\n/**\n * Represents a vote on Top.gg.\n */\nexport const VoteSchema = z.object({\n  /**\n   * The Top.gg ID of the user who voted.\n   */\n  user_id: SnowflakeSchema,\n  /**\n   * The user's ID on the project's platform (e.g., Discord ID).\n   */\n  platform_id: SnowflakeSchema,\n  /**\n   * The amount of votes this vote counted for.\n   */\n  weight: z.number(),\n  /**\n   * The timestamp of when the user voted.\n   */\n  created_at: ISO8601DateSchema,\n  /**\n   * The timestamp of when the vote expires (i.e., when the user can vote again).\n   * This is typically 12 hours after the `created_at` timestamp, but may vary based on the user's voting history and other factors.\n   */\n  expires_at: ISO8601DateSchema,\n});\n\n/**\n * Represents a vote for a specific project.\n */\nexport const ProjectVoteSchema = z.clone(VoteSchema);\n\nexport const WebhookPayloadBaseSchema = <\n  T extends z.infer<typeof WebhookEventTypeSchema>,\n  Data extends z.ZodMiniObject,\n>(\n  type: T,\n  data: Data\n) =>\n  z.object({\n    type: z.literal(type),\n    data: data,\n  });\n\n// # Specific Schemas\n\n// ## Integration Schemas\n\n/**\n * Data included when an integration connection is created.\n */\nexport const IntegrationCreateDataSchema = z.object({\n  /**\n   * The unique identifier for this integration connection.\n   */\n  connection_id: SnowflakeSchema,\n  /**\n   * The webhook secret used to verify webhook requests from Top.gg for this connection.\n   */\n  webhook_secret: z.string().check(z.regex(/^whs_[a-zA-Z0-9]+$/, \"Invalid webhook secret\")),\n  /**\n   * The project this integration is connected to.\n   */\n  project: BaseProjectSchema,\n  /**\n   * The user who created this integration connection.\n   */\n  user: UserSchema,\n});\n\n/**\n * The payload delivered to your webhook endpoint when an integration connection is created.\n * This will be sent if a user clicks \"Connect\" for your integration on the dashboard.\n *\n * @see https://docs.top.gg/docs/API/v1/integrations#2-topgg-sends-integrationcreate\n */\nexport const IntegrationCreateWebhookPayloadSchema = WebhookPayloadBaseSchema(\n  \"integration.create\",\n  IntegrationCreateDataSchema\n);\n\n/**\n * The response you must return from your webhook endpoint when you receive an `integration.create` event.\n * This tells Top.gg where to deliver webhook events for this integration connection and which events to deliver.\n *\n * @see https://docs.top.gg/docs/API/v1/integrations#3-respond-with-configuration\n */\nexport const IntegrationCreateResponseSchema = z.object({\n  /**\n   * The URL where Top.gg should deliver webhook events for this connection.\n   */\n  webhook_url: z.url(),\n  /**\n   * An array of webhook scopes to subscribe to.\n   *\n   * @see https://docs.top.gg/docs/API/v1/webhooks#supported-scopes\n   */\n  routes: z\n    .array(IntegrationSupportedWebhookScopesSchema)\n    .check(\n      z.refine(\n        (arr) => arr.length === new Set(arr).size,\n        \"Duplicate webhook scopes are not allowed\"\n      )\n    ),\n});\n\n/**\n * Data included when an integration connection is deleted.\n */\nexport const IntegrationDeleteDataSchema = z.object({\n  /**\n   * The unique identifier for the integration connection that was deleted.\n   */\n  connection_id: SnowflakeSchema,\n});\n\n/**\n * The payload delivered to your webhook endpoint when an integration connection is deleted.\n */\nexport const IntegrationDeleteWebhookPayloadSchema = WebhookPayloadBaseSchema(\n  \"integration.delete\",\n  IntegrationDeleteDataSchema\n);\n\n// ## Vote Schemas\n\n/**\n * Data included when a vote is created.\n */\nexport const VoteCreateDataSchema = z.extend(VoteSchema, {\n  /**\n   * The project that was voted for.\n   */\n  project: BaseProjectSchema,\n  /**\n   * The user who voted.\n   */\n  user: UserSchema,\n});\n\n/**\n * The payload delivered to your webhook endpoint when a user votes for your project and you have subscribed to the `vote.create` event.\n */\nexport const VoteCreateWebhookPayloadSchema = WebhookPayloadBaseSchema(\n  \"vote.create\",\n  VoteCreateDataSchema\n);\n\n// ## Webhook Test Schemas\n\n/**\n * Data included in a webhook test event.\n */\nexport const WebhookTestDataSchema = z.object({\n  /**\n   * A test user.\n   */\n  user: UserSchema,\n  /**\n   * A test project.\n   */\n  project: BaseProjectSchema,\n});\n\n/**\n * The payload delivered to your webhook endpoint when you send a test webhook from the dashboard or via the API.\n */\nexport const WebhookTestWebhookPayloadSchema = WebhookPayloadBaseSchema(\n  \"webhook.test\",\n  WebhookTestDataSchema\n);\n\n// ## Project Schemas\n\n/**\n * Response schema for getting the authenticated project.\n *\n * - GET `/v1/projects/@me`\n *\n * @see https://docs.top.gg/docs/API/v1/projects#get-current-project\n */\nexport const GetProjectResponseSchema = z.extend(BaseProjectSchema, {\n  /**\n   * The project's name.\n   */\n  name: z.string(),\n  /**\n   * The project's headline/tagline.\n   */\n  headline: z.string(),\n  /**\n   * Tags associated with the project.\n   */\n  tags: z.array(z.string()),\n  /**\n   * The number of votes this month.\n   */\n  votes: z.number(),\n  /**\n   * The total number of votes all time.\n   */\n  votes_total: z.number(),\n  /**\n   * The average review score.\n   */\n  review_score: z.number(),\n  /**\n   * The number of reviews.\n   */\n  review_count: z.number(),\n});\n\n/**\n * Query parameters for getting project votes.\n *\n * - GET `/v1/projects/@me/votes`\n *\n * Either `cursor` or `startDate` must be provided.\n *\n * @see https://docs.top.gg/docs/API/v1/projects/#get-votes\n */\nexport const GetProjectVotesQuerySchema = z\n  .object({\n    /**\n     * Pagination cursor for fetching the next page of votes. if provided, `startDate` is ignored.\n     *\n     * From the previous response.\n     */\n    cursor: z.optional(z.string()),\n    /**\n     * The start date for fetching votes. Only votes created after this date will be returned. Required if `cursor` is not provided.\n     *\n     * Maximum 1 year in the past.\n     *\n     * ISO 8601 date string.\n     */\n    startDate: z.optional(ISO8601DateSchema),\n  })\n  .check(\n    z.refine((data) => data.cursor || data.startDate, \"Either cursor or startDate must be provided\")\n  );\n\n/**\n * Response schema for the Get Project Votes endpoint.\n *\n * - GET `/v1/projects/@me/votes`\n *\n * @see https://docs.top.gg/docs/API/v1/projects/#get-votes\n */\nexport const GetProjectVotesResponseSchema = z.object({\n  /**\n   * Cursor for fetching the next page of votes.\n   */\n  cursor: z.string(),\n  /**\n   * An array of votes for the project.\n   */\n  data: z.array(ProjectVoteSchema),\n});\n\n/**\n * Query parameters for getting vote status by user.\n *\n * - GET `/v1/projects/@me/votes/:user_id`\n *\n * @see https://docs.top.gg/docs/API/v1/projects/#get-vote-status-by-user\n */\nexport const GetVoteStatusByUserQuerySchema = z.object({\n  /**\n   * The source of the user ID. Defaults to \"topgg\".\n   */\n  source: z.optional(UserSourceSchema),\n});\n\n/**\n * Response schema for the Get Vote Status By User endpoint.\n *\n * - GET `/v1/projects/@me/votes/:user_id`\n *\n * @see https://docs.top.gg/docs/API/v1/projects/#get-vote-status-by-user\n */\nexport const GetVoteStatusByUserResponseSchema = z.object({\n  /**\n   * The timestamp of when the user last voted.\n   */\n  created_at: ISO8601DateSchema,\n  /**\n   * The timestamp of when the user's vote expires (i.e., when they can vote again).\n   */\n  expires_at: ISO8601DateSchema,\n  /**\n   * The amount of votes this vote counted for.\n   */\n  weight: z.number(),\n});\n"],"mappings":";;;;;;;;;AAYA,MAAa,yBAAyB,EAAE,KAAK;CAC3C;CACA;CACA;CACA;CACD,CAAC;;;;;;;AAQF,MAAa,oBAAoB,EAAE,KAAK;CAAC;CAAO;CAAU;CAAO,CAAC;;;;AAKlE,MAAa,4BAA4B,EAAE,KAAK,CAAC,WAAW,SAAS,CAAC;;;;;;;AAQtE,MAAa,mBAAmB,EAAE,KAAK,CAAC,WAAW,QAAQ,CAAC;;;;AAK5D,MAAa,0CAA0C,EAAE,KAAK,CAAC,gBAAgB,cAAc,CAAC;;;;AAK9F,MAAa,cAAc,EAAE,OAAO;CAClC,MAAM,EAAE,QAAQ;CAChB,OAAO,EAAE,QAAQ;CACjB,QAAQ,EAAE,QAAQ;CAClB,QAAQ,EAAE,QAAQ;CACnB,CAAC;;;;AAKF,MAAa,aAAa,EAAE,OAAO;CAIjC,IAAI;CAIJ,aAAa;CAIb,MAAM,EAAE,QAAQ;CAIhB,YAAY,EAAE,KAAK;CACpB,CAAC;;;;AAKF,MAAa,oBAAoB,EAAE,OAAO;CAIxC,IAAI;CAIJ,UAAU;CAIV,aAAa;CAIb,MAAM;CACP,CAAC;;;;AAKF,MAAa,aAAa,EAAE,OAAO;CAIjC,SAAS;CAIT,aAAa;CAIb,QAAQ,EAAE,QAAQ;CAIlB,YAAY;CAKZ,YAAY;CACb,CAAC;;;;AAKF,MAAa,oBAAoB,EAAE,MAAM,WAAW;AAEpD,MAAa,4BAIX,MACA,SAEA,EAAE,OAAO;CACP,MAAM,EAAE,QAAQ,KAAK;CACf;CACP,CAAC;;;;AASJ,MAAa,8BAA8B,EAAE,OAAO;CAIlD,eAAe;CAIf,gBAAgB,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,sBAAsB,yBAAyB,CAAC;CAIzF,SAAS;CAIT,MAAM;CACP,CAAC;;;;;;;AAQF,MAAa,wCAAwC,yBACnD,sBACA,4BACD;;;;;;;AAQD,MAAa,kCAAkC,EAAE,OAAO;CAItD,aAAa,EAAE,KAAK;CAMpB,QAAQ,EACL,MAAM,wCAAwC,CAC9C,MACC,EAAE,QACC,QAAQ,IAAI,WAAW,IAAI,IAAI,IAAI,CAAC,MACrC,2CACD,CACF;CACJ,CAAC;;;;AAKF,MAAa,8BAA8B,EAAE,OAAO,EAIlD,eAAe,iBAChB,CAAC;;;;AAKF,MAAa,wCAAwC,yBACnD,sBACA,4BACD;;;;AAOD,MAAa,uBAAuB,EAAE,OAAO,YAAY;CAIvD,SAAS;CAIT,MAAM;CACP,CAAC;;;;AAKF,MAAa,iCAAiC,yBAC5C,eACA,qBACD;;;;AAOD,MAAa,wBAAwB,EAAE,OAAO;CAI5C,MAAM;CAIN,SAAS;CACV,CAAC;;;;AAKF,MAAa,kCAAkC,yBAC7C,gBACA,sBACD;;;;;;;;AAWD,MAAa,2BAA2B,EAAE,OAAO,mBAAmB;CAIlE,MAAM,EAAE,QAAQ;CAIhB,UAAU,EAAE,QAAQ;CAIpB,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC;CAIzB,OAAO,EAAE,QAAQ;CAIjB,aAAa,EAAE,QAAQ;CAIvB,cAAc,EAAE,QAAQ;CAIxB,cAAc,EAAE,QAAQ;CACzB,CAAC;;;;;;;;;;AAWF,MAAa,6BAA6B,EACvC,OAAO;CAMN,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;CAQ9B,WAAW,EAAE,SAAS,kBAAkB;CACzC,CAAC,CACD,MACC,EAAE,QAAQ,SAAS,KAAK,UAAU,KAAK,WAAW,8CAA8C,CACjG;;;;;;;;AASH,MAAa,gCAAgC,EAAE,OAAO;CAIpD,QAAQ,EAAE,QAAQ;CAIlB,MAAM,EAAE,MAAM,kBAAkB;CACjC,CAAC;;;;;;;;AASF,MAAa,iCAAiC,EAAE,OAAO,EAIrD,QAAQ,EAAE,SAAS,iBAAiB,EACrC,CAAC;;;;;;;;AASF,MAAa,oCAAoC,EAAE,OAAO;CAIxD,YAAY;CAIZ,YAAY;CAIZ,QAAQ,EAAE,QAAQ;CACnB,CAAC"}

package/dist/v1.d.cts

@@ -0,0 +1,333 @@
+import { n as Snowflake, t as ISO8601Date } from "./index-Dj7klI6c.cjs";
+
+//#region src/v1/index.d.ts
+
+/**
+ * The type of a webhook event sent by Top.gg to your integration webhook endpoint.
+ *
+ * These are for events related to the integration connection itself (e.g., when it's created or deleted).
+ */
+type IntegrationWebhookEventType = "integration.create" | "integration.delete";
+/**
+ * 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.
+ */
+type ProjectType = "bot" | "server" | "game";
+/**
+ * A Platform is used to identify where the corresponding ID links towards.
+ */
+type ProjectPlatformType = "discord" | "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.
+ */
+type UserSource = "discord" | "topgg";
+/**
+ * Webhook scopes that are supported for integrations.
+ *
+ * These differ from integration webhook event types - these are the events that a user or you can subscribe to for an integration connection,
+ * while the integration webhook event types are the events that are sent to your webhook endpoint when something happens with your integration connection (e.g., it's created or deleted).
+ */
+type WebhookEventType = "webhook.test" | "vote.create";
+type WebhookEventTypes = WebhookEventType | IntegrationWebhookEventType;
+/**
+ * All error responses follow the [`application/problem+json`](https://datatracker.ietf.org/doc/html/rfc7807) specification.
+ */
+interface ErrorResponse {
+  type: string;
+  title: string;
+  status: number;
+  detail: string;
+}
+/**
+ * Represents a user on Top.gg.
+ */
+interface User {
+  /**
+   * The user's Top.gg ID.
+   */
+  id: Snowflake;
+  /**
+   * The user's platform ID (e.g., Discord ID).
+   */
+  platform_id: Snowflake;
+  /**
+   * The user's username.
+   */
+  name: string;
+  /**
+   * The URL of the user's avatar.
+   */
+  avatar_url: string;
+}
+/**
+ * Base project information shared across all project-related responses.
+ */
+interface BaseProject {
+  /**
+   * The project's Top.gg ID.
+   */
+  id: Snowflake;
+  /**
+   * The platform the project is on (e.g., "discord").
+   */
+  platform: ProjectPlatformType;
+  /**
+   * The platform-specific ID of the project (e.g., Discord Bot ID).
+   */
+  platform_id: Snowflake;
+  /**
+   * The type of project (e.g., "bot").
+   */
+  type: ProjectType;
+}
+/**
+ * Represents a vote on Top.gg.
+ */
+interface Vote {
+  /**
+   * The Top.gg ID of the user who voted.
+   */
+  user_id: Snowflake;
+  /**
+   * The user's ID on the project's platform (e.g., Discord ID).
+   */
+  platform_id: Snowflake;
+  /**
+   * The amount of votes this vote counted for.
+   */
+  weight: number;
+  /**
+   * The timestamp of when the user voted.
+   */
+  created_at: ISO8601Date;
+  /**
+   * 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: ISO8601Date;
+}
+/**
+ * Represents a vote for a specific project.
+ */
+type ProjectVote = Vote;
+/**
+ * Base structure for webhook payloads.
+ */
+interface WebhookPayloadBase<T extends WebhookEventTypes, Data extends object> {
+  type: T;
+  data: Data;
+}
+/**
+ * Data included when an integration connection is created.
+ */
+interface IntegrationCreateData {
+  /**
+   * The unique identifier for this integration connection.
+   */
+  connection_id: string;
+  /**
+   * The webhook secret used to verify webhook requests from Top.gg for this connection.
+   */
+  webhook_secret: string;
+  /**
+   * The project this integration is connected to.
+   */
+  project: BaseProject;
+  /**
+   * The user who created this integration connection.
+   */
+  user: User;
+}
+/**
+ * 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
+ */
+type IntegrationCreateWebhookPayload = WebhookPayloadBase<"integration.create", IntegrationCreateData>;
+/**
+ * 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
+ */
+interface IntegrationCreateResponse {
+  /**
+   * The URL where Top.gg should deliver webhook events for this connection.
+   */
+  webhook_url: string;
+  /**
+   * An array of webhook scopes to subscribe to.
+   *
+   * @see https://docs.top.gg/docs/API/v1/webhooks#supported-scopes
+   */
+  routes: WebhookEventTypes[];
+}
+/**
+ * Data included when an integration connection is deleted.
+ */
+interface IntegrationDeleteData {
+  /**
+   * The unique identifier for the integration connection that was deleted.
+   */
+  connection_id: string;
+}
+/**
+ * The payload delivered to your webhook endpoint when an integration connection is deleted.
+ */
+type IntegrationDeleteWebhookPayload = WebhookPayloadBase<"integration.delete", IntegrationDeleteData>;
+/**
+ * Data included when a vote is created.
+ */
+interface VoteCreateData extends Vote {
+  /**
+   * The project that was voted for.
+   */
+  project: BaseProject;
+  /**
+   * The user who voted.
+   */
+  user: User;
+}
+/**
+ * The payload delivered to your webhook endpoint when a user votes for your project and you have subscribed to the `vote.create` event.
+ */
+type VoteCreateWebhookPayload = WebhookPayloadBase<"vote.create", VoteCreateData>;
+/**
+ * Data included in a webhook test event.
+ */
+interface WebhookTestData {
+  /**
+   * A test user.
+   */
+  user: User;
+  /**
+   * A test project.
+   */
+  project: BaseProject;
+}
+/**
+ * The payload delivered to your webhook endpoint when you send a test webhook from the dashboard or via the API.
+ */
+type WebhookTestWebhookPayload = WebhookPayloadBase<"webhook.test", WebhookTestData>;
+/**
+ * Response for getting the authenticated project.
+ *
+ * - GET `/v1/projects/@me`
+ *
+ * @see https://docs.top.gg/docs/API/v1/projects#get-current-project
+ */
+interface GetProjectResponse extends BaseProject {
+  /**
+   * The project's name.
+   */
+  name: string;
+  /**
+   * The project's headline/tagline.
+   */
+  headline: string;
+  /**
+   * Tags associated with the project.
+   */
+  tags: string[];
+  /**
+   * The number of votes this month.
+   */
+  votes: number;
+  /**
+   * The total number of votes all time.
+   */
+  votes_total: number;
+  /**
+   * The average review score.
+   */
+  review_score: number;
+  /**
+   * The number of reviews.
+   */
+  review_count: number;
+}
+/**
+ * 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
+ */
+interface GetProjectVotesQuery {
+  /**
+   * Pagination cursor for fetching the next page of votes. if provided, `startDate` is ignored.
+   *
+   * From the previous response.
+   */
+  cursor?: 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?: string;
+}
+/**
+ * Response for the Get Project Votes endpoint.
+ *
+ * - GET `/v1/projects/@me/votes`
+ *
+ * @see https://docs.top.gg/docs/API/v1/projects/#get-votes
+ */
+interface GetProjectVotesResponse {
+  /**
+   * Cursor for fetching the next page of votes.
+   */
+  cursor: string;
+  /**
+   * An array of votes for the project.
+   */
+  data: ProjectVote[];
+}
+/**
+ * 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
+ */
+interface GetVoteStatusByUserQuery {
+  /**
+   * The source of the user ID. Defaults to "topgg".
+   */
+  source?: UserSource;
+}
+/**
+ * Response 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
+ */
+interface GetVoteStatusByUserResponse {
+  /**
+   * The timestamp of when the user last voted.
+   */
+  created_at: ISO8601Date;
+  /**
+   * The timestamp of when the user's vote expires (i.e., when they can vote again).
+   */
+  expires_at: ISO8601Date;
+  /**
+   * The amount of votes this vote counted for.
+   */
+  weight: number;
+}
+//#endregion
+export { BaseProject, ErrorResponse, GetProjectResponse, GetProjectVotesQuery, GetProjectVotesResponse, GetVoteStatusByUserQuery, GetVoteStatusByUserResponse, IntegrationCreateData, IntegrationCreateResponse, IntegrationCreateWebhookPayload, IntegrationDeleteData, IntegrationDeleteWebhookPayload, IntegrationWebhookEventType, ProjectPlatformType, ProjectType, ProjectVote, User, UserSource, Vote, VoteCreateData, VoteCreateWebhookPayload, WebhookEventType, WebhookEventTypes, WebhookPayloadBase, WebhookTestData, WebhookTestWebhookPayload };
+//# sourceMappingURL=v1.d.cts.map