feat(api): add files endpoints (#136)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 50
+configured_endpoints: 53
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/julep-ai-inc-dash%2Fjulep-88cc6342d69fe97f2a853ea6603be32f004effeb54c78bdaeabada214bba8e5d.yml

api.md

@@ -49,6 +49,18 @@ Methods:
 - <code title="delete /agents/{agent_id}/docs/{doc_id}">client.agents.docs.<a href="./src/resources/agents/docs.ts">delete</a>(agentId, docId) -> ResourceDeleted</code>
 - <code title="post /agents/{agent_id}/search">client.agents.docs.<a href="./src/resources/agents/docs.ts">search</a>(agentId, { ...params }) -> DocSearchResponse</code>
 
+# Files
+
+Types:
+
+- <code><a href="./src/resources/files.ts">File</a></code>
+
+Methods:
+
+- <code title="post /files">client.files.<a href="./src/resources/files.ts">create</a>({ ...params }) -> ResourceCreated</code>
+- <code title="delete /files/{file_id}">client.files.<a href="./src/resources/files.ts">delete</a>(fileId) -> ResourceDeleted</code>
+- <code title="get /files/{file_id}">client.files.<a href="./src/resources/files.ts">get</a>(fileId) -> File</code>
+
 # Sessions
 
 Types:

src/index.ts

@@ -9,6 +9,7 @@ import { type OffsetPaginationParams, OffsetPaginationResponse } from './paginat
 import * as Uploads from './uploads';
 import * as API from './resources/index';
 import { Doc, DocEmbedParams, Docs, EmbedQueryResponse, Snippet } from './resources/docs';
+import { File, FileCreateParams, Files } from './resources/files';
 import { JobStatus, Jobs } from './resources/jobs';
 import {
   ChatInput,
@@ -208,6 +209,7 @@ export class Julep extends Core.APIClient {
   }
 
   agents: API.Agents = new API.Agents(this);
+  files: API.Files = new API.Files(this);
   sessions: API.Sessions = new API.Sessions(this);
   users: API.Users = new API.Users(this);
   jobs: API.Jobs = new API.Jobs(this);
@@ -257,6 +259,7 @@ export class Julep extends Core.APIClient {
 
 Julep.Agents = Agents;
 Julep.AgentsOffsetPagination = AgentsOffsetPagination;
+Julep.Files = Files;
 Julep.Sessions = Sessions;
 Julep.SessionsOffsetPagination = SessionsOffsetPagination;
 Julep.Users = Users;
@@ -287,6 +290,8 @@ export declare namespace Julep {
     type AgentPatchParams as AgentPatchParams,
   };
 
+  export { Files as Files, type File as File, type FileCreateParams as FileCreateParams };
+
   export {
     Sessions as Sessions,
     type ChatInput as ChatInput,

src/resources/files.ts

@@ -0,0 +1,60 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as Shared from './shared';
+
+export class Files extends APIResource {
+  /**
+   * Create File
+   */
+  create(body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.ResourceCreated> {
+    return this._client.post('/files', { body, ...options });
+  }
+
+  /**
+   * Delete File
+   */
+  delete(fileId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.ResourceDeleted> {
+    return this._client.delete(`/files/${fileId}`, options);
+  }
+
+  /**
+   * Get File
+   */
+  get(fileId: string, options?: Core.RequestOptions): Core.APIPromise<File> {
+    return this._client.get(`/files/${fileId}`, options);
+  }
+}
+
+export interface File {
+  id: string;
+
+  content: string;
+
+  created_at: string;
+
+  hash: string;
+
+  name: string;
+
+  size: number;
+
+  description?: string;
+
+  mime_type?: string | null;
+}
+
+export interface FileCreateParams {
+  content: string;
+
+  name: string;
+
+  description?: string;
+
+  mime_type?: string | null;
+}
+
+export declare namespace Files {
+  export { type File as File, type FileCreateParams as FileCreateParams };
+}

src/resources/index.ts

@@ -19,6 +19,7 @@ export {
   type Snippet,
   type DocEmbedParams,
 } from './docs';
+export { Files, type File, type FileCreateParams } from './files';
 export { Jobs, type JobStatus } from './jobs';
 export {
   SessionsOffsetPagination,

tests/api-resources/files.test.ts

@@ -0,0 +1,67 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import Julep from '@julep/sdk';
+import { Response } from 'node-fetch';
+
+const client = new Julep({
+  apiKey: 'My API Key',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
+
+describe('resource files', () => {
+  test('create: only required params', async () => {
+    const responsePromise = client.files.create({ content: 'content', name: 'name' });
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('create: required and optional params', async () => {
+    const response = await client.files.create({
+      content: 'content',
+      name: 'name',
+      description: 'description',
+      mime_type: 'mime_type',
+    });
+  });
+
+  test('delete', async () => {
+    const responsePromise = client.files.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('delete: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      client.files.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(Julep.NotFoundError);
+  });
+
+  test('get', async () => {
+    const responsePromise = client.files.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('get: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      client.files.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(Julep.NotFoundError);
+  });
+});