fix: fix types to match current api response (#26)

* fix: fix types to match current API out. fixes #25

* fix: match keyresponse and member types with expected API output

* fix: make output backwards compatible with sdk versions

* fix: possible deprecation notice for method output changing

* Modifying KeyResponse object

Co-authored-by: Michael Jolley <mike@sparcapp.io>

Author: lukeocodes

src/keys.ts

@@ -11,12 +11,21 @@ export class Keys {
    * @param projectId Unique identifier of the project containing API keys
    */
   async list(projectId: string): Promise<KeyResponse> {
-    return _request<KeyResponse>(
+    const response = await _request<KeyResponse>(
       "GET",
       this._credentials,
       this._apiUrl,
       `${this.apiPath}/${projectId}/keys`
     );
+
+    const output = response.api_keys.map((apiKey) => {
+      return {
+        ...apiKey, 
+        ...apiKey.api_key
+      }
+    });
+
+    return { api_keys: output };
   }
 
   /**

src/types/keyResponse.ts

@@ -1,4 +1,5 @@
 import { Key } from "./key";
+import { Member } from "./member";
 
 /**
  * Response from the Deepgram API to list keys
@@ -7,5 +8,46 @@ export type KeyResponse = {
   /**
    * Array of API keys associated with the project
    */
-  api_keys: Array<Key>;
+  api_keys: Array<{
+    /**
+     * Optional member associated with the API key
+     */
+    member?: Member;
+
+    /**
+     * API key
+     */
+    api_key: Key;
+
+    /**
+     * Unique identifier of the key to use in API requests
+     * @deprecated This property has moved to api_key.api_key_id and will
+     * be removed in future versions.
+     */
+    api_key_id: string;
+    /**
+     * API key to send in API requests (Only displayed when first created)
+     * @deprecated This property has moved to api_key.key and will
+     * be removed in future versions.
+     */
+    key?: string;
+    /**
+     * Comment for user reference
+     * @deprecated This property has moved to api_key.comment and will
+     * be removed in future versions.
+     */
+    comment: string;
+    /**
+     * Timestamp of the date/time the key was created
+     * @deprecated This property has moved to api_key.created and will
+     * be removed in future versions.
+     */
+    created: string;
+    /**
+     * Array of scopes assigned to the key
+     * @deprecated This property has moved to api_key.scopes and will
+     * be removed in future versions.
+     */
+    scopes: Array<string>;
+  }>;
 };

src/types/member.ts

@@ -1,6 +1,6 @@
 export type Member = {
-  id: string;
-  name: string;
-  scopes: Array<string>;
+  member_id: string;
+  name?: string;
+  scopes?: Array<string>;
   email: string;
 };