@valtown/sdk 2.0.0 → 3.0.0

package/src/resources/orgs.ts

@@ -1,8 +1,8 @@
 // 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 { APIResource } from '../core/resource';
+import { PageCursorURL, type PageCursorURLParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
 
 /**
  * Get information about organizations you belong to
@@ -13,13 +13,13 @@ export class Orgs extends APIResource {
    */
   list(
     query: OrgListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<OrgListResponsesPageCursorURL, OrgListResponse> {
-    return this._client.getAPIList('/v2/orgs', OrgListResponsesPageCursorURL, { query, ...options });
+    options?: RequestOptions,
+  ): PagePromise<OrgListResponsesPageCursorURL, OrgListResponse> {
+    return this._client.getAPIList('/v2/orgs', PageCursorURL<OrgListResponse>, { query, ...options });
   }
 }
 
-export class OrgListResponsesPageCursorURL extends PageCursorURL<OrgListResponse> {}
+export type OrgListResponsesPageCursorURL = PageCursorURL<OrgListResponse>;
 
 /**
  * An Org
@@ -35,12 +35,10 @@ export interface OrgListResponse {
 
 export interface OrgListParams extends PageCursorURLParams {}
 
-Orgs.OrgListResponsesPageCursorURL = OrgListResponsesPageCursorURL;
-
 export declare namespace Orgs {
   export {
     type OrgListResponse as OrgListResponse,
-    OrgListResponsesPageCursorURL as OrgListResponsesPageCursorURL,
+    type 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

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
+import { APIResource } from '../../core/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

@@ -1,111 +1,17 @@
 // 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 { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { BasicValsPageCursorURL } from '../shared';
+import { PageCursorURL, type PageCursorURLParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Vals extends APIResource {
   /**
    * Search for vals across the platform
    */
-  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;
+  list(query: ValListParams, options?: RequestOptions): PagePromise<BasicValsPageCursorURL, Shared.BasicVal> {
+    return this._client.getAPIList('/v1/search/vals', PageCursorURL<Shared.BasicVal>, { query, ...options });
   }
 }
 
@@ -116,12 +22,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 { type 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 '../core/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 ValsPageCursorURL extends PageCursorURL<Val> {}
+export type BasicValsPageCursorURL = PageCursorURL<BasicVal>;
+
+export type ValsPageCursorURL = PageCursorURL<Val>;
+
+export type ValsCursor = Cursor<Val>;

package/src/resources/sqlite.ts

@@ -1,8 +1,9 @@
 // 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 { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
 
 /**
  * Vals access a shared SQLite database
@@ -19,7 +20,7 @@ export class Sqlite extends APIResource {
    * });
    * ```
    */
-  batch(body: SqliteBatchParams, options?: Core.RequestOptions): Core.APIPromise<SqliteBatchResponse> {
+  batch(body: SqliteBatchParams, options?: RequestOptions): APIPromise<SqliteBatchResponse> {
     return this._client.post('/v1/sqlite/batch', { body, ...options });
   }
 
@@ -33,7 +34,7 @@ export class Sqlite extends APIResource {
    * });
    * ```
    */
-  execute(body: SqliteExecuteParams, options?: Core.RequestOptions): Core.APIPromise<Shared.ResultSet> {
+  execute(body: SqliteExecuteParams, options?: RequestOptions): APIPromise<Shared.ResultSet> {
     return this._client.post('/v1/sqlite/execute', { body, ...options });
   }
 }

package/src/resources/telemetry/logs.ts

@@ -1,8 +1,9 @@
 // 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 { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Logs extends APIResource {
   /**
@@ -12,7 +13,7 @@ export class Logs extends APIResource {
    * get resources within the time window. Filter additionally by branch_ids or
    * file_id.
    */
-  list(query: LogListParams, options?: Core.RequestOptions): Core.APIPromise<LogListResponse> {
+  list(query: LogListParams, options?: RequestOptions): APIPromise<LogListResponse> {
     return this._client.get('/v1/telemetry/logs', { query, ...options });
   }
 }

package/src/resources/telemetry/telemetry.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
+import { APIResource } from '../../core/resource';
 import * as LogsAPI from './logs';
 import { LogListParams, LogListResponse, Logs } from './logs';
 import * as TracesAPI from './traces';

package/src/resources/telemetry/traces.ts

@@ -1,8 +1,9 @@
 // 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 { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Traces extends APIResource {
   /**
@@ -13,7 +14,7 @@ export class Traces extends APIResource {
    * to view traces that completed in a window or since a time. Filter additionally
    * by branch_ids or file_id.
    */
-  list(query: TraceListParams, options?: Core.RequestOptions): Core.APIPromise<TraceListResponse> {
+  list(query: TraceListParams, options?: RequestOptions): APIPromise<TraceListResponse> {
     return this._client.get('/v1/telemetry/traces', { query, ...options });
   }
 }

package/src/resources/users.ts

@@ -1,8 +1,10 @@
 // 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 { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 /**
  * Access public user information and list other people’s vals
@@ -18,7 +20,7 @@ export class Users extends APIResource {
    * );
    * ```
    */
-  retrieve(userId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.User> {
-    return this._client.get(`/v1/users/${userId}`, options);
+  retrieve(userID: string, options?: RequestOptions): APIPromise<Shared.User> {
+    return this._client.get(path`/v1/users/${userID}`, options);
   }
 }

package/src/resources/vals/branches.ts

@@ -1,8 +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 { 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 Branches extends APIResource {
   /**
@@ -20,11 +23,11 @@ export class Branches extends APIResource {
    * ```
    */
   create(
-    valId: string,
+    valID: string,
     body: BranchCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<BranchCreateResponse> {
-    return this._client.post(`/v2/vals/${valId}/branches`, { body, ...options });
+    options?: RequestOptions,
+  ): APIPromise<BranchCreateResponse> {
+    return this._client.post(path`/v2/vals/${valID}/branches`, { body, ...options });
   }
 
   /**
@@ -34,16 +37,17 @@ export class Branches extends APIResource {
    * ```ts
    * const branch = await client.vals.branches.retrieve(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { val_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
    * );
    * ```
    */
   retrieve(
-    valId: string,
-    branchId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<BranchRetrieveResponse> {
-    return this._client.get(`/v2/vals/${valId}/branches/${branchId}`, options);
+    branchID: string,
+    params: BranchRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<BranchRetrieveResponse> {
+    const { val_id } = params;
+    return this._client.get(path`/v2/vals/${val_id}/branches/${branchID}`, options);
   }
 
   /**
@@ -61,11 +65,11 @@ export class Branches extends APIResource {
    * ```
    */
   list(
-    valId: string,
+    valID: string,
     query: BranchListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<BranchListResponsesPageCursorURL, BranchListResponse> {
-    return this._client.getAPIList(`/v2/vals/${valId}/branches`, BranchListResponsesPageCursorURL, {
+    options?: RequestOptions,
+  ): PagePromise<BranchListResponsesPageCursorURL, BranchListResponse> {
+    return this._client.getAPIList(path`/v2/vals/${valID}/branches`, PageCursorURL<BranchListResponse>, {
       query,
       ...options,
     });
@@ -78,19 +82,20 @@ export class Branches extends APIResource {
    * ```ts
    * await client.vals.branches.delete(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { val_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
    * );
    * ```
    */
-  delete(valId: string, branchId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.delete(`/v2/vals/${valId}/branches/${branchId}`, {
+  delete(branchID: string, params: BranchDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { val_id } = params;
+    return this._client.delete(path`/v2/vals/${val_id}/branches/${branchID}`, {
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }
 
-export class BranchListResponsesPageCursorURL extends PageCursorURL<BranchListResponse> {}
+export type BranchListResponsesPageCursorURL = PageCursorURL<BranchListResponse>;
 
 /**
  * A Branch
@@ -219,17 +224,31 @@ export interface BranchCreateParams {
   branchId?: string;
 }
 
+export interface BranchRetrieveParams {
+  /**
+   * Id of a val
+   */
+  val_id: string;
+}
+
 export interface BranchListParams extends PageCursorURLParams {}
 
-Branches.BranchListResponsesPageCursorURL = BranchListResponsesPageCursorURL;
+export interface BranchDeleteParams {
+  /**
+   * Id of a val
+   */
+  val_id: string;
+}
 
 export declare namespace Branches {
   export {
     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,
   };
 }