feat: exposing types for creating API keys to plugins (#1225)

## 🧰 Changes

Exposes a new `APIKeyRepresentation` type for use in plugins.

Author: erunion

src/lib/types/index.ts

@@ -16,6 +16,9 @@ type guidesRequestBodySchema =
 type projectSchema =
   (typeof readmeAPIv2Oas)['paths']['/projects/me']['get']['responses']['200']['content']['application/json']['schema'];
 
+type apiKeySchema =
+  (typeof readmeAPIv2Oas)['paths']['/projects/{subdomain}/apikeys/{api_key_id}']['get']['responses']['200']['content']['application/json']['schema'];
+
 /**
  * Derived from our API documentation, this is the schema for the `guides` object
  * as we send it to the ReadMe API.
@@ -29,3 +32,5 @@ export type GuidesRequestRepresentation = FromSchema<
 >;
 
 export type ProjectRepresentation = FromSchema<projectSchema, { keepDefaultedPropertiesOptional: true }>;
+
+export type APIKeyRepresentation = FromSchema<apiKeySchema, { keepDefaultedPropertiesOptional: true }>;

src/types.ts

@@ -1,4 +1,4 @@
-export type { GuidesRequestRepresentation, ProjectRepresentation } from './lib/types/index.js';
+export type { APIKeyRepresentation, GuidesRequestRepresentation, ProjectRepresentation } from './lib/types/index.js';
 export type { PageMetadata } from './lib/readPage.js';
 export type { PluginHooks } from './lib/hooks/exported.js';
 export type { ResponseBody } from './lib/readmeAPIFetch.js';