Merge branch 'main' into fix/ts-specific-issues

.gitignore

@@ -127,4 +127,6 @@ dist
 .yarn/unplugged
 .yarn/build-state.yml
 .yarn/install-state.gz
-.pnp.*
+.pnp.*
+
+.DS_Store

README.md

@@ -9,6 +9,8 @@ npm install portkey-ai
 
 ## Features
 
+The Portkey SDK is built on top of the OpenAI SDK, allowing you to seamlessly integrate Portkey's advanced features while retaining full compatibility with OpenAI methods. With Portkey, you can enhance your interactions with OpenAI or any other OpenAI-like provider by leveraging robust monitoring, reliability, prompt management, and more features - without modifying much of your existing code.
+
 ### AI Gateway
 <table>
     <tr>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "portkey-ai",
-  "version": "1.1.5",
+  "version": "1.3.1",
   "description": "Node client library for the Portkey API",
   "types": "dist/src/index.d.ts",
   "main": "dist/src/index.js",
@@ -41,6 +41,7 @@
   },
   "dependencies": {
     "agentkeepalive": "^4.5.0",
-    "dotenv": "^16.3.1"
+    "dotenv": "^16.3.1",
+    "openai": "4.36.0"
   }
 }

src/_types/generalTypes.ts

@@ -10,6 +10,23 @@ export interface ApiClientInterface {
     metadata?: Record<string, unknown> | null | undefined;
     Authorization?: string | null | undefined;
     cacheForceRefresh?: boolean | null | undefined;
+    debug?: boolean | null | undefined;
+    customHost?: string | null | undefined;
+    openaiProject?: string | null | undefined;
+    openaiOrganization?: string | null | undefined;
+    awsSecretAccessKey?: string | null | undefined;
+    awsAccessKeyId?: string | null | undefined;
+    awsSessionToken?: string | null | undefined;
+    awsRegion?: string | null | undefined;
+    vertexProjectId?: string | null | undefined;
+    vertexRegion?: string | null | undefined;
+    workersAiAccountId?: string | null | undefined;
+    azureResourceName?: string | null | undefined;
+    azureDeploymentId?: string | null | undefined;
+    azureApiVersion?: string | null | undefined;
+    forwardHeaders?: Array<string> | null | undefined;
+    cacheNamespace?: string | null | undefined;
+    requestTimeout?: number | null | undefined;
 }
 
 export interface APIResponseType {

src/apiResource.ts

@@ -3,9 +3,11 @@ import type { Portkey } from "./index";
 export class ApiResource {
 	protected client: Portkey;
 	protected post: Portkey["_post"]
+	protected put: Portkey["_put"]
 
 	constructor(client: Portkey) {
 		this.client = client
 		this.post = client._post.bind(client)
+		this.put = client._put.bind(client)
 	}
 }