@valtown/sdk 1.14.0 → 2.1.0

package/src/resources/orgs.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../resource';
 import * as Core from '../core';
-import * as Shared from './shared';
+import { PageCursorURL, type PageCursorURLParams } from '../pagination';
 
 /**
  * Get information about organizations you belong to
@@ -11,49 +11,36 @@ export class Orgs extends APIResource {
   /**
    * Get all orgs you are a member of
    */
-  retrieve(query: OrgRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<OrgRetrieveResponse> {
-    return this._client.get('/v2/orgs', { query, ...options });
+  list(
+    query: OrgListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<OrgListResponsesPageCursorURL, OrgListResponse> {
+    return this._client.getAPIList('/v2/orgs', OrgListResponsesPageCursorURL, { query, ...options });
   }
 }
 
+export class OrgListResponsesPageCursorURL extends PageCursorURL<OrgListResponse> {}
+
 /**
- * A paginated result set
+ * An Org
  */
-export interface OrgRetrieveResponse {
-  data: Array<OrgRetrieveResponse.Data>;
-
-  /**
-   * Links to use for pagination
-   */
-  links: Shared.PaginationLinks;
-}
-
-export namespace OrgRetrieveResponse {
+export interface OrgListResponse {
   /**
-   * An Org
+   * The id of the org
    */
-  export interface Data {
-    /**
-     * The id of the org
-     */
-    id: string;
+  id: string;
 
-    username: string;
-  }
+  username: string;
 }
 
-export interface OrgRetrieveParams {
-  /**
-   * Maximum items to return in each paginated response
-   */
-  limit: number;
+export interface OrgListParams extends PageCursorURLParams {}
 
-  /**
-   * Number of items to skip in order to deliver paginated results
-   */
-  offset: number;
-}
+Orgs.OrgListResponsesPageCursorURL = OrgListResponsesPageCursorURL;
 
 export declare namespace Orgs {
-  export { type OrgRetrieveResponse as OrgRetrieveResponse, type OrgRetrieveParams as OrgRetrieveParams };
+  export {
+    type OrgListResponse as OrgListResponse,
+    OrgListResponsesPageCursorURL as OrgListResponsesPageCursorURL,
+    type OrgListParams as OrgListParams,
+  };
 }

package/src/resources/search/index.ts

@@ -1,4 +1,4 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Search } from './search';
-export { ValListResponsesPageCursorURL, Vals, type ValListResponse, type ValListParams } from './vals';
+export { Vals, type ValListParams } from './vals';

package/src/resources/search/search.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../../resource';
 import * as ValsAPI from './vals';
-import { ValListParams, ValListResponse, ValListResponsesPageCursorURL, Vals } from './vals';
+import { ValListParams, Vals } from './vals';
 
 /**
  * Search endpoint for vals
@@ -12,13 +12,7 @@ export class Search extends APIResource {
 }
 
 Search.Vals = Vals;
-Search.ValListResponsesPageCursorURL = ValListResponsesPageCursorURL;
 
 export declare namespace Search {
-  export {
-    Vals as Vals,
-    type ValListResponse as ValListResponse,
-    ValListResponsesPageCursorURL as ValListResponsesPageCursorURL,
-    type ValListParams as ValListParams,
-  };
+  export { Vals as Vals, type ValListParams as ValListParams };
 }

package/src/resources/search/vals.ts

@@ -2,7 +2,9 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
-import { PageCursorURL, type PageCursorURLParams } from '../../pagination';
+import * as Shared from '../shared';
+import { BasicValsPageCursorURL } from '../shared';
+import { type PageCursorURLParams } from '../../pagination';
 
 export class Vals extends APIResource {
   /**
@@ -11,101 +13,8 @@ export class Vals extends APIResource {
   list(
     query: ValListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ValListResponsesPageCursorURL, ValListResponse> {
-    return this._client.getAPIList('/v1/search/vals', ValListResponsesPageCursorURL, { query, ...options });
-  }
-}
-
-export class ValListResponsesPageCursorURL extends PageCursorURL<ValListResponse> {}
-
-/**
- * A Val
- */
-export interface ValListResponse {
-  /**
-   * This val's id
-   */
-  id: string;
-
-  /**
-   * The user who created this val
-   */
-  author: ValListResponse.Author | null;
-
-  /**
-   * TypeScript code associated with this val
-   */
-  code: string | null;
-
-  createdAt: string;
-
-  links: ValListResponse.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 ValListResponse {
-  /**
-   * 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;
+  ): Core.PagePromise<BasicValsPageCursorURL, Shared.BasicVal> {
+    return this._client.getAPIList('/v1/search/vals', BasicValsPageCursorURL, { query, ...options });
   }
 }
 
@@ -116,12 +25,8 @@ export interface ValListParams extends PageCursorURLParams {
   query: string;
 }
 
-Vals.ValListResponsesPageCursorURL = ValListResponsesPageCursorURL;
-
 export declare namespace Vals {
-  export {
-    type ValListResponse as ValListResponse,
-    ValListResponsesPageCursorURL as ValListResponsesPageCursorURL,
-    type ValListParams as ValListParams,
-  };
+  export { type ValListParams as ValListParams };
 }
+
+export { BasicValsPageCursorURL };

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';