feat(api): api update (#518)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 37
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/val-town%2Fval-town-fdb8597c76fe77a92ca60e29d54dc0cc907861b822a699ed026232f758d5eaee.yml
+configured_endpoints: 38
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/val-town%2Fval-town-77a415f3dc452e48f6f1eb82618bfb4faf2192baf78f6a279efe4a725ca7d2f2.yml

api.md

@@ -198,11 +198,13 @@ Methods:
 
 Types:
 
+- <code><a href="./src/resources/projects/files.ts">FileCreateResponse</a></code>
 - <code><a href="./src/resources/projects/files.ts">FileRetrieveResponse</a></code>
 - <code><a href="./src/resources/projects/files.ts">FileListResponse</a></code>
 
 Methods:
 
+- <code title="post /v1/projects/{project_id}/files/{path}">client.projects.files.<a href="./src/resources/projects/files.ts">create</a>(projectId, path, { ...params }) -> FileCreateResponse</code>
 - <code title="get /v1/projects/{project_id}/files/{path}">client.projects.files.<a href="./src/resources/projects/files.ts">retrieve</a>(projectId, path, { ...params }) -> FileRetrieveResponse</code>
 - <code title="get /v1/projects/{project_id}/files">client.projects.files.<a href="./src/resources/projects/files.ts">list</a>(projectId, { ...params }) -> FileListResponsesPageCursorURL</code>
 - <code title="get /v1/projects/{project_id}/files/{path}/content">client.projects.files.<a href="./src/resources/projects/files.ts">content</a>(projectId, path, { ...params }) -> Response</code>

src/resources/projects/files.ts

@@ -8,6 +8,23 @@ import { PageCursorURL, type PageCursorURLParams } from '../../pagination';
 import { type Response } from '../../_shims/index';
 
 export class Files extends APIResource {
+  /**
+   * [BETA] Create a new file, project val or directory
+   */
+  create(
+    projectId: string,
+    path: string,
+    params: FileCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<FileCreateResponse> {
+    const { branch_id, ...body } = params;
+    return this._client.post(`/v1/projects/${projectId}/files/${path}`, {
+      query: { branch_id },
+      body,
+      ...options,
+    });
+  }
+
   /**
    * Get metadata for files and directories in a project at the specified path
    */
@@ -80,6 +97,52 @@ export class Files extends APIResource {
 
 export class FileListResponsesPageCursorURL extends PageCursorURL<FileListResponse> {}
 
+/**
+ * A File or Directory's Metadata
+ */
+export interface FileCreateResponse {
+  /**
+   * The id of the resource
+   */
+  id: string;
+
+  links: FileCreateResponse.Links;
+
+  name: string;
+
+  path: string;
+
+  type: 'directory' | 'file' | 'interval' | 'http' | 'email' | 'script';
+
+  updatedAt: string;
+
+  version: number;
+}
+
+export namespace FileCreateResponse {
+  export interface Links {
+    /**
+     * The URL of this resource on Val Town
+     */
+    html: string;
+
+    /**
+     * The URL of this resource's source code as a module
+     */
+    module: string;
+
+    /**
+     * The URL of this resource on this API
+     */
+    self: string;
+
+    /**
+     * This resource's web endpoint, where it serves a website or API
+     */
+    endpoint?: string;
+  }
+}
+
 /**
  * A paginated result set
  */
@@ -186,6 +249,48 @@ export namespace FileListResponse {
   }
 }
 
+export type FileCreateParams = FileCreateParams.Variant0 | FileCreateParams.Variant1;
+
+export declare namespace FileCreateParams {
+  export interface Variant0 {
+    /**
+     * Body param:
+     */
+    type: 'directory';
+
+    /**
+     * Query param: Id of the branch to create the file on. Defaults to main if not
+     * provided.
+     */
+    branch_id?: string;
+
+    /**
+     * Body param:
+     */
+    content?: null;
+  }
+
+  export interface Variant1 {
+    /**
+     * Body param: Project file and val content. Null or an empty string will create an
+     * empty file. When creating a directory, you can send null, an empty string, or
+     * omit the content field entirely.
+     */
+    content: string;
+
+    /**
+     * Body param:
+     */
+    type: 'file' | 'interval' | 'http' | 'email' | 'script';
+
+    /**
+     * Query param: Id of the branch to create the file on. Defaults to main if not
+     * provided.
+     */
+    branch_id?: string;
+  }
+}
+
 export interface FileRetrieveParams {
   /**
    * Maximum items to return in each paginated response
@@ -266,9 +371,11 @@ Files.FileListResponsesPageCursorURL = FileListResponsesPageCursorURL;
 
 export declare namespace Files {
   export {
+    type FileCreateResponse as FileCreateResponse,
     type FileRetrieveResponse as FileRetrieveResponse,
     type FileListResponse as FileListResponse,
     FileListResponsesPageCursorURL as FileListResponsesPageCursorURL,
+    type FileCreateParams as FileCreateParams,
     type FileRetrieveParams as FileRetrieveParams,
     type FileListParams as FileListParams,
     type FileContentParams as FileContentParams,

src/resources/projects/index.ts

@@ -12,8 +12,10 @@ export {
 export {
   FileListResponsesPageCursorURL,
   Files,
+  type FileCreateResponse,
   type FileRetrieveResponse,
   type FileListResponse,
+  type FileCreateParams,
   type FileRetrieveParams,
   type FileListParams,
   type FileContentParams,

src/resources/projects/projects.ts

@@ -15,6 +15,8 @@ import {
 import * as FilesAPI from './files';
 import {
   FileContentParams,
+  FileCreateParams,
+  FileCreateResponse,
   FileListParams,
   FileListResponse,
   FileListResponsesPageCursorURL,
@@ -251,9 +253,11 @@ export declare namespace Projects {
 
   export {
     Files as Files,
+    type FileCreateResponse as FileCreateResponse,
     type FileRetrieveResponse as FileRetrieveResponse,
     type FileListResponse as FileListResponse,
     FileListResponsesPageCursorURL as FileListResponsesPageCursorURL,
+    type FileCreateParams as FileCreateParams,
     type FileRetrieveParams as FileRetrieveParams,
     type FileListParams as FileListParams,
     type FileContentParams as FileContentParams,

tests/api-resources/projects/files.test.ts

@@ -9,6 +9,27 @@ const client = new ValTown({
 });
 
 describe('resource files', () => {
+  test('create: only required params', async () => {
+    const responsePromise = client.projects.files.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', 'path', {
+      type: 'directory',
+    });
+    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.projects.files.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', 'path', {
+      type: 'directory',
+      branch_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+      content: null,
+    });
+  });
+
   test('retrieve: only required params', async () => {
     const responsePromise = client.projects.files.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', 'path', {
       limit: 1,