@valtown/sdk 2.0.0 → 3.0.0

package/src/resources/vals/environment-variables.ts

@@ -0,0 +1,214 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { PageCursorURL, type PageCursorURLParams, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Settings and secrets for Vals
+ */
+export class EnvironmentVariables extends APIResource {
+  /**
+   * Create a new environment variable scoped to this project.
+   *
+   * @example
+   * ```ts
+   * const environmentVariable =
+   *   await client.vals.environmentVariables.create(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { key: 'key', value: 'value' },
+   *   );
+   * ```
+   */
+  create(
+    valID: string,
+    body: EnvironmentVariableCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<EnvironmentVariableCreateResponse> {
+    return this._client.post(path`/v2/vals/${valID}/environment_variables`, { body, ...options });
+  }
+
+  /**
+   * Update a environment variable scoped to this project.
+   *
+   * @example
+   * ```ts
+   * const environmentVariable =
+   *   await client.vals.environmentVariables.update('key', {
+   *     val_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     value: 'value',
+   *   });
+   * ```
+   */
+  update(
+    key: string,
+    params: EnvironmentVariableUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<EnvironmentVariableUpdateResponse> {
+    const { val_id, ...body } = params;
+    return this._client.put(path`/v2/vals/${val_id}/environment_variables/${key}`, { body, ...options });
+  }
+
+  /**
+   * List environment variables defined in this project. This only includes names,
+   * not values.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const environmentVariableListResponse of client.vals.environmentVariables.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { limit: 1, offset: 0 },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    valID: string,
+    query: EnvironmentVariableListParams,
+    options?: RequestOptions,
+  ): PagePromise<EnvironmentVariableListResponsesPageCursorURL, EnvironmentVariableListResponse> {
+    return this._client.getAPIList(
+      path`/v2/vals/${valID}/environment_variables`,
+      PageCursorURL<EnvironmentVariableListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Delete a environment variable scoped to this project.
+   *
+   * @example
+   * ```ts
+   * await client.vals.environmentVariables.delete('key', {
+   *   val_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * });
+   * ```
+   */
+  delete(key: string, params: EnvironmentVariableDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { val_id } = params;
+    return this._client.delete(path`/v2/vals/${val_id}/environment_variables/${key}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type EnvironmentVariableListResponsesPageCursorURL = PageCursorURL<EnvironmentVariableListResponse>;
+
+/**
+ * An environment variable
+ */
+export interface EnvironmentVariableCreateResponse {
+  createdAt: string;
+
+  /**
+   * Optional description of the environment variable
+   */
+  description: string | null;
+
+  /**
+   * Name or key of the environment variable, accessible via Deno.env or process.env
+   */
+  key: string;
+
+  updatedAt: string;
+}
+
+/**
+ * An environment variable
+ */
+export interface EnvironmentVariableUpdateResponse {
+  createdAt: string;
+
+  /**
+   * Optional description of the environment variable
+   */
+  description: string | null;
+
+  /**
+   * Name or key of the environment variable, accessible via Deno.env or process.env
+   */
+  key: string;
+
+  updatedAt: string;
+}
+
+/**
+ * An environment variable
+ */
+export interface EnvironmentVariableListResponse {
+  createdAt: string;
+
+  /**
+   * Optional description of the environment variable
+   */
+  description: string | null;
+
+  /**
+   * Name or key of the environment variable, accessible via Deno.env or process.env
+   */
+  key: string;
+
+  updatedAt: string;
+}
+
+export interface EnvironmentVariableCreateParams {
+  /**
+   * Name or key of the environment variable, accessible via Deno.env or process.env
+   */
+  key: string;
+
+  /**
+   * Value of the environment variable.
+   */
+  value: string;
+
+  /**
+   * Optional description of the environment variable
+   */
+  description?: string;
+}
+
+export interface EnvironmentVariableUpdateParams {
+  /**
+   * Path param: Id of a val
+   */
+  val_id: string;
+
+  /**
+   * Body param: Value of the environment variable.
+   */
+  value: string;
+
+  /**
+   * Body param: Optional description of the environment variable
+   */
+  description?: string;
+}
+
+export interface EnvironmentVariableListParams extends PageCursorURLParams {}
+
+export interface EnvironmentVariableDeleteParams {
+  /**
+   * Id of a val
+   */
+  val_id: string;
+}
+
+export declare namespace EnvironmentVariables {
+  export {
+    type EnvironmentVariableCreateResponse as EnvironmentVariableCreateResponse,
+    type EnvironmentVariableUpdateResponse as EnvironmentVariableUpdateResponse,
+    type EnvironmentVariableListResponse as EnvironmentVariableListResponse,
+    type EnvironmentVariableListResponsesPageCursorURL as EnvironmentVariableListResponsesPageCursorURL,
+    type EnvironmentVariableCreateParams as EnvironmentVariableCreateParams,
+    type EnvironmentVariableUpdateParams as EnvironmentVariableUpdateParams,
+    type EnvironmentVariableListParams as EnvironmentVariableListParams,
+    type EnvironmentVariableDeleteParams as EnvironmentVariableDeleteParams,
+  };
+}

package/src/resources/vals/files.ts

@@ -1,9 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
-import { PageCursorURL, type PageCursorURLParams } from '../../pagination';
-import { type Response } from '../../_shims/index';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { PageCursorURL, type PageCursorURLParams, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Files extends APIResource {
   /**
@@ -17,13 +19,9 @@ export class Files extends APIResource {
    * );
    * ```
    */
-  create(
-    valId: string,
-    params: FileCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<FileCreateResponse> {
+  create(valID: string, params: FileCreateParams, options?: RequestOptions): APIPromise<FileCreateResponse> {
     const { path: path_, branch_id, ...body } = params;
-    return this._client.post(`/v2/vals/${valId}/files`, {
+    return this._client.post(path`/v2/vals/${valID}/files`, {
       query: { path: path_, branch_id },
       body,
       ...options,
@@ -46,11 +44,11 @@ export class Files extends APIResource {
    * ```
    */
   retrieve(
-    valId: string,
+    valID: string,
     query: FileRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<FileRetrieveResponsesPageCursorURL, FileRetrieveResponse> {
-    return this._client.getAPIList(`/v2/vals/${valId}/files`, FileRetrieveResponsesPageCursorURL, {
+    options?: RequestOptions,
+  ): PagePromise<FileRetrieveResponsesPageCursorURL, FileRetrieveResponse> {
+    return this._client.getAPIList(path`/v2/vals/${valID}/files`, PageCursorURL<FileRetrieveResponse>, {
       query,
       ...options,
     });
@@ -67,13 +65,9 @@ export class Files extends APIResource {
    * );
    * ```
    */
-  update(
-    valId: string,
-    params: FileUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<FileUpdateResponse> {
+  update(valID: string, params: FileUpdateParams, options?: RequestOptions): APIPromise<FileUpdateResponse> {
     const { path: path_, branch_id, ...body } = params;
-    return this._client.put(`/v2/vals/${valId}/files`, {
+    return this._client.put(path`/v2/vals/${valID}/files`, {
       query: { path: path_, branch_id },
       body,
       ...options,
@@ -93,12 +87,12 @@ export class Files extends APIResource {
    * );
    * ```
    */
-  delete(valId: string, params: FileDeleteParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+  delete(valID: string, params: FileDeleteParams, options?: RequestOptions): APIPromise<void> {
     const { path: path_, recursive, branch_id } = params;
-    return this._client.delete(`/v2/vals/${valId}/files`, {
+    return this._client.delete(path`/v2/vals/${valID}/files`, {
       query: { path: path_, recursive, branch_id },
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
@@ -116,11 +110,7 @@ export class Files extends APIResource {
    * console.log(content);
    * ```
    */
-  getContent(
-    valId: string,
-    params: FileGetContentParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Response> {
+  getContent(valID: string, params: FileGetContentParams, options?: RequestOptions): APIPromise<Response> {
     const {
       'Cache-Control': cacheControl,
       'If-Match': ifMatch,
@@ -129,24 +119,26 @@ export class Files extends APIResource {
       'If-Unmodified-Since': ifUnmodifiedSince,
       ...query
     } = params;
-    return this._client.get(`/v2/vals/${valId}/files/content`, {
+    return this._client.get(path`/v2/vals/${valID}/files/content`, {
       query,
       ...options,
-      headers: {
-        Accept: 'application/octet-stream',
-        ...(cacheControl != null ? { 'Cache-Control': cacheControl } : undefined),
-        ...(ifMatch != null ? { 'If-Match': ifMatch } : undefined),
-        ...(ifModifiedSince != null ? { 'If-Modified-Since': ifModifiedSince } : undefined),
-        ...(ifNoneMatch != null ? { 'If-None-Match': ifNoneMatch } : undefined),
-        ...(ifUnmodifiedSince != null ? { 'If-Unmodified-Since': ifUnmodifiedSince } : undefined),
-        ...options?.headers,
-      },
+      headers: buildHeaders([
+        {
+          Accept: 'application/octet-stream',
+          ...(cacheControl != null ? { 'Cache-Control': cacheControl } : undefined),
+          ...(ifMatch != null ? { 'If-Match': ifMatch } : undefined),
+          ...(ifModifiedSince != null ? { 'If-Modified-Since': ifModifiedSince } : undefined),
+          ...(ifNoneMatch != null ? { 'If-None-Match': ifNoneMatch } : undefined),
+          ...(ifUnmodifiedSince != null ? { 'If-Unmodified-Since': ifUnmodifiedSince } : undefined),
+        },
+        options?.headers,
+      ]),
       __binaryResponse: true,
     });
   }
 }
 
-export class FileRetrieveResponsesPageCursorURL extends PageCursorURL<FileRetrieveResponse> {}
+export type FileRetrieveResponsesPageCursorURL = PageCursorURL<FileRetrieveResponse>;
 
 /**
  * A File or Directory's Metadata
@@ -459,14 +451,12 @@ export interface FileGetContentParams {
   'If-Unmodified-Since'?: string;
 }
 
-Files.FileRetrieveResponsesPageCursorURL = FileRetrieveResponsesPageCursorURL;
-
 export declare namespace Files {
   export {
     type FileCreateResponse as FileCreateResponse,
     type FileRetrieveResponse as FileRetrieveResponse,
     type FileUpdateResponse as FileUpdateResponse,
-    FileRetrieveResponsesPageCursorURL as FileRetrieveResponsesPageCursorURL,
+    type FileRetrieveResponsesPageCursorURL as FileRetrieveResponsesPageCursorURL,
     type FileCreateParams as FileCreateParams,
     type FileRetrieveParams as FileRetrieveParams,
     type FileUpdateParams as FileUpdateParams,

package/src/resources/vals/index.ts

@@ -1,16 +1,28 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  BranchListResponsesPageCursorURL,
   Branches,
   type BranchCreateResponse,
   type BranchRetrieveResponse,
   type BranchListResponse,
   type BranchCreateParams,
+  type BranchRetrieveParams,
   type BranchListParams,
+  type BranchDeleteParams,
+  type BranchListResponsesPageCursorURL,
 } from './branches';
 export {
-  FileRetrieveResponsesPageCursorURL,
+  EnvironmentVariables,
+  type EnvironmentVariableCreateResponse,
+  type EnvironmentVariableUpdateResponse,
+  type EnvironmentVariableListResponse,
+  type EnvironmentVariableCreateParams,
+  type EnvironmentVariableUpdateParams,
+  type EnvironmentVariableListParams,
+  type EnvironmentVariableDeleteParams,
+  type EnvironmentVariableListResponsesPageCursorURL,
+} from './environment-variables';
+export {
   Files,
   type FileCreateResponse,
   type FileRetrieveResponse,
@@ -20,5 +32,6 @@ export {
   type FileUpdateParams,
   type FileDeleteParams,
   type FileGetContentParams,
+  type FileRetrieveResponsesPageCursorURL,
 } from './files';
-export { Vals, type ValListResponse, type ValCreateParams, type ValListParams } from './vals';
+export { Vals, type ValCreateParams, type ValListParams } from './vals';

package/src/resources/vals/vals.ts

@@ -1,18 +1,32 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
+import { ValsCursor } from '../shared';
 import * as BranchesAPI from './branches';
 import {
   BranchCreateParams,
   BranchCreateResponse,
+  BranchDeleteParams,
   BranchListParams,
   BranchListResponse,
   BranchListResponsesPageCursorURL,
+  BranchRetrieveParams,
   BranchRetrieveResponse,
   Branches,
 } from './branches';
+import * as EnvironmentVariablesAPI from './environment-variables';
+import {
+  EnvironmentVariableCreateParams,
+  EnvironmentVariableCreateResponse,
+  EnvironmentVariableDeleteParams,
+  EnvironmentVariableListParams,
+  EnvironmentVariableListResponse,
+  EnvironmentVariableListResponsesPageCursorURL,
+  EnvironmentVariableUpdateParams,
+  EnvironmentVariableUpdateResponse,
+  EnvironmentVariables,
+} from './environment-variables';
 import * as FilesAPI from './files';
 import {
   FileCreateParams,
@@ -26,6 +40,11 @@ import {
   FileUpdateResponse,
   Files,
 } from './files';
+import { APIPromise } from '../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 /**
  * Vals are a collaborative folder of runnable JavaScript, TypeScript, and JSX modules
@@ -33,6 +52,8 @@ import {
 export class Vals extends APIResource {
   branches: BranchesAPI.Branches = new BranchesAPI.Branches(this._client);
   files: FilesAPI.Files = new FilesAPI.Files(this._client);
+  environmentVariables: EnvironmentVariablesAPI.EnvironmentVariables =
+    new EnvironmentVariablesAPI.EnvironmentVariables(this._client);
 
   /**
    * Create a new val
@@ -46,7 +67,7 @@ export class Vals extends APIResource {
    * });
    * ```
    */
-  create(body: ValCreateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Val> {
+  create(body: ValCreateParams, options?: RequestOptions): APIPromise<Shared.Val> {
     return this._client.post('/v2/vals', { body, ...options });
   }
 
@@ -60,8 +81,8 @@ export class Vals extends APIResource {
    * );
    * ```
    */
-  retrieve(valId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Val> {
-    return this._client.get(`/v2/vals/${valId}`, options);
+  retrieve(valID: string, options?: RequestOptions): APIPromise<Shared.Val> {
+    return this._client.get(path`/v2/vals/${valID}`, options);
   }
 
   /**
@@ -69,11 +90,14 @@ export class Vals extends APIResource {
    *
    * @example
    * ```ts
-   * const vals = await client.vals.list({ limit: 1 });
+   * // Automatically fetches more pages as needed.
+   * for await (const val of client.vals.list({ limit: 1 })) {
+   *   // ...
+   * }
    * ```
    */
-  list(query: ValListParams, options?: Core.RequestOptions): Core.APIPromise<ValListResponse> {
-    return this._client.get('/v2/vals', { query, ...options });
+  list(query: ValListParams, options?: RequestOptions): PagePromise<ValsCursor, Shared.Val> {
+    return this._client.getAPIList('/v2/vals', Cursor<Shared.Val>, { query, ...options });
   }
 
   /**
@@ -86,26 +110,14 @@ export class Vals extends APIResource {
    * );
    * ```
    */
-  delete(valId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.delete(`/v2/vals/${valId}`, {
+  delete(valID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v2/vals/${valID}`, {
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }
 
-/**
- * A paginated result set
- */
-export interface ValListResponse {
-  data: Array<Shared.Val>;
-
-  /**
-   * Links to use for pagination
-   */
-  links: Shared.PaginationLinks;
-}
-
 export interface ValCreateParams {
   name: string;
 
@@ -119,17 +131,12 @@ export interface ValCreateParams {
   orgId?: string;
 }
 
-export interface ValListParams {
+export interface ValListParams extends CursorParams {
   /**
    * Maximum items to return in each paginated response
    */
   limit: number;
 
-  /**
-   * Cursor to start the pagination from
-   */
-  cursor?: string;
-
   /**
    * This resource's privacy setting. Unlisted resources do not appear on profile
    * pages or elsewhere, but you can link to them.
@@ -143,25 +150,22 @@ export interface ValListParams {
 }
 
 Vals.Branches = Branches;
-Vals.BranchListResponsesPageCursorURL = BranchListResponsesPageCursorURL;
 Vals.Files = Files;
-Vals.FileRetrieveResponsesPageCursorURL = FileRetrieveResponsesPageCursorURL;
+Vals.EnvironmentVariables = EnvironmentVariables;
 
 export declare namespace Vals {
-  export {
-    type ValListResponse as ValListResponse,
-    type ValCreateParams as ValCreateParams,
-    type ValListParams as ValListParams,
-  };
+  export { type ValCreateParams as ValCreateParams, type ValListParams as ValListParams };
 
   export {
     Branches as Branches,
     type BranchCreateResponse as BranchCreateResponse,
     type BranchRetrieveResponse as BranchRetrieveResponse,
     type BranchListResponse as BranchListResponse,
-    BranchListResponsesPageCursorURL as BranchListResponsesPageCursorURL,
+    type BranchListResponsesPageCursorURL as BranchListResponsesPageCursorURL,
     type BranchCreateParams as BranchCreateParams,
+    type BranchRetrieveParams as BranchRetrieveParams,
     type BranchListParams as BranchListParams,
+    type BranchDeleteParams as BranchDeleteParams,
   };
 
   export {
@@ -169,11 +173,25 @@ export declare namespace Vals {
     type FileCreateResponse as FileCreateResponse,
     type FileRetrieveResponse as FileRetrieveResponse,
     type FileUpdateResponse as FileUpdateResponse,
-    FileRetrieveResponsesPageCursorURL as FileRetrieveResponsesPageCursorURL,
+    type FileRetrieveResponsesPageCursorURL as FileRetrieveResponsesPageCursorURL,
     type FileCreateParams as FileCreateParams,
     type FileRetrieveParams as FileRetrieveParams,
     type FileUpdateParams as FileUpdateParams,
     type FileDeleteParams as FileDeleteParams,
     type FileGetContentParams as FileGetContentParams,
   };
+
+  export {
+    EnvironmentVariables as EnvironmentVariables,
+    type EnvironmentVariableCreateResponse as EnvironmentVariableCreateResponse,
+    type EnvironmentVariableUpdateResponse as EnvironmentVariableUpdateResponse,
+    type EnvironmentVariableListResponse as EnvironmentVariableListResponse,
+    type EnvironmentVariableListResponsesPageCursorURL as EnvironmentVariableListResponsesPageCursorURL,
+    type EnvironmentVariableCreateParams as EnvironmentVariableCreateParams,
+    type EnvironmentVariableUpdateParams as EnvironmentVariableUpdateParams,
+    type EnvironmentVariableListParams as EnvironmentVariableListParams,
+    type EnvironmentVariableDeleteParams as EnvironmentVariableDeleteParams,
+  };
 }
+
+export { type ValsCursor };

package/src/tsconfig.json

@@ -4,8 +4,8 @@
   // via declaration maps
   "include": ["index.ts"],
   "compilerOptions": {
-    "target": "es2015",
-    "lib": ["DOM"],
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
     "moduleResolution": "node"
   }
 }