@valtown/sdk 2.0.0 → 2.1.0

package/src/resources/shared.ts

@@ -1,6 +1,202 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { PageCursorURL } from '../pagination';
+import { Cursor, PageCursorURL } from '../pagination';
+
+/**
+ * A Val
+ */
+export interface BasicVal {
+  /**
+   * This val's id
+   */
+  id: string;
+
+  /**
+   * The user who created this val
+   */
+  author: BasicVal.Author | null;
+
+  /**
+   * TypeScript code associated with this val
+   */
+  code: string | null;
+
+  createdAt: string;
+
+  links: BasicVal.Links;
+
+  /**
+   * The name of this val
+   */
+  name: string;
+
+  /**
+   * This resource's privacy setting. Unlisted resources do not appear on profile
+   * pages or elsewhere, but you can link to them.
+   */
+  privacy: 'public' | 'unlisted' | 'private';
+
+  /**
+   * Whether this val is available publicly on Val Town
+   */
+  public: boolean;
+
+  /**
+   * The type of a val. HTTP can receive web requests, Email can receive emails, Cron
+   * runs periodically, and Script can be used for libraries or one-off calculations
+   */
+  type: 'interval' | 'http' | 'express' | 'email' | 'script' | 'rpc' | 'httpnext';
+
+  updatedAt: string;
+
+  /**
+   * The URL of this resource on the Val Town website
+   */
+  url: string;
+
+  /**
+   * The version of this val, starting at zero
+   */
+  version: number;
+}
+
+export namespace BasicVal {
+  /**
+   * The user who created this val
+   */
+  export interface Author {
+    id: string;
+
+    username: string | null;
+  }
+
+  export interface Links {
+    /**
+     * The URL of this Val's source code as a module
+     */
+    module: string;
+
+    /**
+     * The URL of this val on this API
+     */
+    self: string;
+
+    /**
+     * The endpoint to retrieve this val's versions
+     */
+    versions: string;
+
+    /**
+     * This val's web endpoint, where it serves a website or API
+     */
+    endpoint?: string;
+  }
+}
+
+/**
+ * A Legacy Val
+ */
+export interface ExtendedVal {
+  /**
+   * This val's id
+   */
+  id: string;
+
+  /**
+   * The user who created this val
+   */
+  author: ExtendedVal.Author | null;
+
+  /**
+   * TypeScript code associated with this val
+   */
+  code: string | null;
+
+  createdAt: string;
+
+  /**
+   * How many likes this val has received
+   */
+  likeCount: number;
+
+  links: ExtendedVal.Links;
+
+  /**
+   * The name of this val
+   */
+  name: string;
+
+  /**
+   * This resource's privacy setting. Unlisted resources do not appear on profile
+   * pages or elsewhere, but you can link to them.
+   */
+  privacy: 'public' | 'unlisted' | 'private';
+
+  /**
+   * Whether this val is available publicly on Val Town
+   */
+  public: boolean;
+
+  /**
+   * This val's readme, as Markdown
+   */
+  readme: string | null;
+
+  referenceCount: number;
+
+  /**
+   * The type of a val. HTTP can receive web requests, Email can receive emails, Cron
+   * runs periodically, and Script can be used for libraries or one-off calculations
+   */
+  type: 'interval' | 'http' | 'express' | 'email' | 'script' | 'rpc' | 'httpnext';
+
+  updatedAt: string;
+
+  /**
+   * The URL of this resource on the Val Town website
+   */
+  url: string;
+
+  /**
+   * The version of this val, starting at zero
+   */
+  version: number;
+
+  versionCreatedAt?: string;
+}
+
+export namespace ExtendedVal {
+  /**
+   * The user who created this val
+   */
+  export interface Author {
+    id: string;
+
+    username: string | null;
+  }
+
+  export interface Links {
+    /**
+     * The URL of this Val's source code as a module
+     */
+    module: string;
+
+    /**
+     * The URL of this val on this API
+     */
+    self: string;
+
+    /**
+     * The endpoint to retrieve this val's versions
+     */
+    versions: string;
+
+    /**
+     * This val's web endpoint, where it serves a website or API
+     */
+    endpoint?: string;
+  }
+}
 
 /**
  * Links to use for pagination
@@ -165,4 +361,8 @@ export namespace Val {
   }
 }
 
+export class BasicValsPageCursorURL extends PageCursorURL<BasicVal> {}
+
 export class ValsPageCursorURL extends PageCursorURL<Val> {}
+
+export class ValsCursor extends Cursor<Val> {}

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

@@ -0,0 +1,199 @@
+// 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';
+
+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?: Core.RequestOptions,
+  ): Core.APIPromise<EnvironmentVariableCreateResponse> {
+    return this._client.post(`/v2/vals/${valId}/environment_variables`, { body, ...options });
+  }
+
+  /**
+   * Update a environment variable scoped to this project.
+   *
+   * @example
+   * ```ts
+   * const environmentVariable =
+   *   await client.vals.environmentVariables.update(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     'key',
+   *     { value: 'value' },
+   *   );
+   * ```
+   */
+  update(
+    valId: string,
+    key: string,
+    body: EnvironmentVariableUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EnvironmentVariableUpdateResponse> {
+    return this._client.put(`/v2/vals/${valId}/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?: Core.RequestOptions,
+  ): Core.PagePromise<EnvironmentVariableListResponsesPageCursorURL, EnvironmentVariableListResponse> {
+    return this._client.getAPIList(
+      `/v2/vals/${valId}/environment_variables`,
+      EnvironmentVariableListResponsesPageCursorURL,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Delete a environment variable scoped to this project.
+   *
+   * @example
+   * ```ts
+   * await client.vals.environmentVariables.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   'key',
+   * );
+   * ```
+   */
+  delete(valId: string, key: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v2/vals/${valId}/environment_variables/${key}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}
+
+export class EnvironmentVariableListResponsesPageCursorURL extends 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 {
+  /**
+   * Value of the environment variable.
+   */
+  value: string;
+
+  /**
+   * Optional description of the environment variable
+   */
+  description?: string;
+}
+
+export interface EnvironmentVariableListParams extends PageCursorURLParams {}
+
+EnvironmentVariables.EnvironmentVariableListResponsesPageCursorURL =
+  EnvironmentVariableListResponsesPageCursorURL;
+
+export declare namespace EnvironmentVariables {
+  export {
+    type EnvironmentVariableCreateResponse as EnvironmentVariableCreateResponse,
+    type EnvironmentVariableUpdateResponse as EnvironmentVariableUpdateResponse,
+    type EnvironmentVariableListResponse as EnvironmentVariableListResponse,
+    EnvironmentVariableListResponsesPageCursorURL as EnvironmentVariableListResponsesPageCursorURL,
+    type EnvironmentVariableCreateParams as EnvironmentVariableCreateParams,
+    type EnvironmentVariableUpdateParams as EnvironmentVariableUpdateParams,
+    type EnvironmentVariableListParams as EnvironmentVariableListParams,
+  };
+}

package/src/resources/vals/index.ts

@@ -9,6 +9,16 @@ export {
   type BranchCreateParams,
   type BranchListParams,
 } from './branches';
+export {
+  EnvironmentVariableListResponsesPageCursorURL,
+  EnvironmentVariables,
+  type EnvironmentVariableCreateResponse,
+  type EnvironmentVariableUpdateResponse,
+  type EnvironmentVariableListResponse,
+  type EnvironmentVariableCreateParams,
+  type EnvironmentVariableUpdateParams,
+  type EnvironmentVariableListParams,
+} from './environment-variables';
 export {
   FileRetrieveResponsesPageCursorURL,
   Files,
@@ -21,4 +31,4 @@ export {
   type FileDeleteParams,
   type FileGetContentParams,
 } 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

@@ -3,6 +3,7 @@
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import * as Shared from '../shared';
+import { ValsCursor } from '../shared';
 import * as BranchesAPI from './branches';
 import {
   BranchCreateParams,
@@ -13,6 +14,17 @@ import {
   BranchRetrieveResponse,
   Branches,
 } from './branches';
+import * as EnvironmentVariablesAPI from './environment-variables';
+import {
+  EnvironmentVariableCreateParams,
+  EnvironmentVariableCreateResponse,
+  EnvironmentVariableListParams,
+  EnvironmentVariableListResponse,
+  EnvironmentVariableListResponsesPageCursorURL,
+  EnvironmentVariableUpdateParams,
+  EnvironmentVariableUpdateResponse,
+  EnvironmentVariables,
+} from './environment-variables';
 import * as FilesAPI from './files';
 import {
   FileCreateParams,
@@ -26,6 +38,7 @@ import {
   FileUpdateResponse,
   Files,
 } from './files';
+import { type CursorParams } from '../../pagination';
 
 /**
  * Vals are a collaborative folder of runnable JavaScript, TypeScript, and JSX modules
@@ -33,6 +46,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
@@ -69,11 +84,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?: Core.RequestOptions): Core.PagePromise<ValsCursor, Shared.Val> {
+    return this._client.getAPIList('/v2/vals', ValsCursor, { query, ...options });
   }
 
   /**
@@ -94,18 +112,6 @@ export class Vals extends APIResource {
   }
 }
 
-/**
- * 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 +125,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.
@@ -146,13 +147,11 @@ Vals.Branches = Branches;
 Vals.BranchListResponsesPageCursorURL = BranchListResponsesPageCursorURL;
 Vals.Files = Files;
 Vals.FileRetrieveResponsesPageCursorURL = FileRetrieveResponsesPageCursorURL;
+Vals.EnvironmentVariables = EnvironmentVariables;
+Vals.EnvironmentVariableListResponsesPageCursorURL = EnvironmentVariableListResponsesPageCursorURL;
 
 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,
@@ -176,4 +175,17 @@ export declare namespace Vals {
     type FileDeleteParams as FileDeleteParams,
     type FileGetContentParams as FileGetContentParams,
   };
+
+  export {
+    EnvironmentVariables as EnvironmentVariables,
+    type EnvironmentVariableCreateResponse as EnvironmentVariableCreateResponse,
+    type EnvironmentVariableUpdateResponse as EnvironmentVariableUpdateResponse,
+    type EnvironmentVariableListResponse as EnvironmentVariableListResponse,
+    EnvironmentVariableListResponsesPageCursorURL as EnvironmentVariableListResponsesPageCursorURL,
+    type EnvironmentVariableCreateParams as EnvironmentVariableCreateParams,
+    type EnvironmentVariableUpdateParams as EnvironmentVariableUpdateParams,
+    type EnvironmentVariableListParams as EnvironmentVariableListParams,
+  };
 }
+
+export { ValsCursor };

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.0.0'; // x-release-please-version
+export const VERSION = '2.1.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.0.0";
+export declare const VERSION = "2.1.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.0.0'; // x-release-please-version
+exports.VERSION = '2.1.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.0.0'; // x-release-please-version
+export const VERSION = '2.1.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map