theauthapi 1.0.8 → 1.0.9

package/README.md

@@ -6,11 +6,11 @@
   - [Installation](#installation)
   - [Configuration](#configuration)
   - [Usage](#usage)
-    - [Example: Validating an api-key](#example-validating-an-api-key)
-    - [Example: Listing API-keys](#example-listing-api-keys)
+    - [Example: Validating an API-Key](#example-validating-an-api-key)
+    - [Example: Listing API-Keys](#example-listing-api-keys)
     - [Example: Listing the projects of an account](#example-listing-the-projects-of-an-account)
-    - [Example: Listing projects and associated API Keys](#example-listing-projects-and-associated-api-keys)
-    - [Example: Creating an API Key](#example-creating-an-api-key)
+    - [Example: Listing projects and associated API-Keys](#example-listing-projects-and-associated-api-keys)
+    - [Example: Creating an API-Key](#example-creating-an-api-key)
     - [Handling Errors](#handling-errors)
     - [Typescript](#typescript)
     - [📙 Further Reading](#-further-reading)
@@ -104,7 +104,7 @@ All methods return a promise containing the returned JSON as a javascript object
 | DELETE      | delete\*    | `client.apiKeys.deleteKey("MY_KEY")`                                      |
 | PATCH       | update\*    | `client.apiKeys.updateKey("MY_KEY", { name: "UPDATED_KEY_NAME" })`        |
 
-#### Example: Validating an api-key
+#### Example: Validating an API-Key
 
 You can easily validate an API key using `apiKeys.isValidKey` which returns `true` if the key is valid, `false` otherwise.
 `isValidKey` throws an `ApiRequestError` if there's a network issue, it's advised to wrap it in a `try/catch` to handle the potential error
@@ -182,6 +182,10 @@ try {
 }
 ```
 
+**NOTE** that if your access key is at account level, you need to specify `projectId` when listing the API keys: 
+`getKeys({ projectId: "PROJECT_ID" })`, otherwise if your access key is created at project level, you don't have to specify `projectId`, 
+the access key's `projectId` will be used to get the API-keys (i.e. you'll see only the keys of the project your access key is created against)
+
 #### Example: Listing the projects of an account
 
 ```javascript
@@ -201,7 +205,7 @@ try {
 }
 ```
 
-#### Example: Listing projects and associated API Keys
+#### Example: Listing projects and associated API-Keys
 
 ```javascript
 async function getProjectsWithKeys(accountId: string) {
@@ -218,7 +222,7 @@ async function getProjectsWithKeys(accountId: string) {
 }
 ```
 
-#### Example: Creating an API Key
+#### Example: Creating an API-Key
 
 ```javascript
 theAuthAPI.apiKeys

package/dist/libraryMeta.d.ts

@@ -1 +1 @@
-export declare const version = "1.0.6";
+export declare const version = "1.0.9";

package/dist/libraryMeta.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = "1.0.6";
+exports.version = "1.0.9";

package/dist/types/index.d.ts

@@ -1,17 +1,17 @@
 export declare type ApiKey = {
     key: string;
     name: string;
-    customMetaData: string;
+    customMetaData: object;
     customAccountId: string;
     customUserId: string;
-    env: string;
+    env: Environment;
     createdAt: Date;
     updatedAt: Date;
     isActive: boolean;
 };
 export declare type RateLimitConfiguration = {
     rateLimitedEntity?: string;
-    ratelimitedEnitityId?: any;
+    ratelimitedEnitityId?: string;
     rateLimit: number;
     rateLimitTtl: number;
 };
@@ -21,8 +21,8 @@ export declare type ApiKeyInput = {
     key?: string;
     customMetaData?: object;
     customAccountId?: string;
-    rateLimitConfigs?: RateLimitConfiguration;
     customUserId?: string;
+    rateLimitConfigs?: RateLimitConfiguration;
 };
 export declare type ApiKeyFilter = {
     projectId?: string;
@@ -53,7 +53,7 @@ export declare type Project = AuthBaseEntity & {
     id: string;
     name: string;
     accountId: string;
-    env: string;
+    env: Environment;
 };
 export declare enum Environment {
     LIVE = "live",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "theauthapi",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Client library for TheAuthAPI.com",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",