feat: add function for getting deployment

Author: mattrothenberg

index.d.ts

@@ -89,6 +89,28 @@ declare module "replicate" {
     retry?: number;
   }
 
+  export interface Deployment {
+    owner: string;
+    name: string;
+    current_release: {
+      number: number;
+      model: string;
+      version: string;
+      created_at: string;
+      created_by: {
+        type: "user" | "organization";
+        username: string;
+        name: string;
+        github_url: string;
+      };
+      configuration: {
+        hardware: string;
+        min_instances: number;
+        max_instances: number;
+      };
+    };
+  }
+
   export default class Replicate {
     constructor(options?: {
       auth?: string;
@@ -169,6 +191,10 @@ declare module "replicate" {
           }
         ): Promise<Prediction>;
       };
+      get(
+        deployment_owner: string,
+        deployment_name: string
+      ): Promise<Deployment>;
     };
 
     hardware: {

index.js

@@ -58,6 +58,7 @@ class Replicate {
     };
 
     this.deployments = {
+      get: deployments.get.bind(this),
       predictions: {
         create: deployments.predictions.create.bind(this),
       },

index.test.ts

@@ -716,6 +716,42 @@ describe("Replicate client", () => {
     // Add more tests for error handling, edge cases, etc.
   });
 
+  describe("deployments.get", () => {
+    test("Calls the correct API route with the correct payload", async () => {
+      nock(BASE_URL)
+        .get("/deployments/replicate/greeter")
+        .reply(200, {
+          owner: "replicate",
+          name: "greeter",
+          current_release: {
+            number: 1,
+            model: "replicate/hello-world",
+            version:
+              "5c7d5dc6dd8bf75c1acaa8565735e7986bc5b66206b55cca93cb72c9bf15ccaa",
+            created_at: "2022-09-10T09:44:22.165836Z",
+            created_by: {
+              type: "organization",
+              username: "replicate",
+              name: "Replicate",
+              github_url: "https://github.com/replicate",
+            },
+            configuration: {
+              hardware: "gpu-a100",
+              min_instances: 0,
+              max_instances: 1,
+            },
+          },
+        });
+
+      const deployment = await client.deployments.get("replicate", "greeter");
+
+      expect(deployment.owner).toBe("replicate");
+      expect(deployment.name).toBe("greeter");
+      expect(deployment.current_release.model).toBe("replicate/hello-world");
+    });
+    // Add more tests for error handling, edge cases, etc.
+  });
+
   describe("predictions.create with model", () => {
     test("Calls the correct API route with the correct payload", async () => {
       nock(BASE_URL)

lib/deployments.js

@@ -33,8 +33,26 @@ async function createPrediction(deployment_owner, deployment_name, options) {
   return response.json();
 }
 
+/**
+ * Get a deployment
+ * @param {string} deployment_owner - Required. The username of the user or organization who owns the deployment
+ * @param {string} deployment_name - Required. The name of the deployment
+ * @returns {Promise<object>} Resolves with the deployment data
+ */
+async function getDeployment(deployment_owner, deployment_name) {
+  const response = await this.request(
+    `/deployments/${deployment_owner}/${deployment_name}`,
+    {
+      method: "GET",
+    }
+  );
+
+  return response.json();
+}
+
 module.exports = {
   predictions: {
     create: createPrediction,
   },
+  get: getDeployment,
 };