@valtown/sdk 1.1.0 → 1.2.0

package/resources/vals/vals.mjs

@@ -1,6 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../../resource.mjs";
-import { ValsPageCursorURL } from "../shared.mjs";
 import * as BranchesAPI from "./branches.mjs";
 import { BranchListResponsesPageCursorURL, Branches, } from "./branches.mjs";
 import * as FilesAPI from "./files.mjs";
@@ -16,24 +15,52 @@ export class Vals extends APIResource {
     }
     /**
      * Create a new val
+     *
+     * @example
+     * ```ts
+     * const val = await client.vals.create({
+     *   name: 'myVal',
+     *   privacy: 'public',
+     *   description: 'My val',
+     * });
+     * ```
      */
     create(body, options) {
         return this._client.post('/v2/vals', { body, ...options });
     }
     /**
      * Get a val by id
+     *
+     * @example
+     * ```ts
+     * const val = await client.vals.retrieve(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
      */
     retrieve(valId, options) {
         return this._client.get(`/v2/vals/${valId}`, options);
     }
     /**
-     * Lists all public vals
+     * Lists all vals including all public vals and your unlisted and private vals
+     *
+     * @example
+     * ```ts
+     * const vals = await client.vals.list({ limit: 1 });
+     * ```
      */
     list(query, options) {
-        return this._client.getAPIList('/v2/vals', ValsPageCursorURL, { query, ...options });
+        return this._client.get('/v2/vals', { query, ...options });
     }
     /**
      * Delete a project
+     *
+     * @example
+     * ```ts
+     * await client.vals.delete(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
      */
     delete(valId, options) {
         return this._client.delete(`/v2/vals/${valId}`, {
@@ -46,5 +73,4 @@ Vals.Branches = Branches;
 Vals.BranchListResponsesPageCursorURL = BranchListResponsesPageCursorURL;
 Vals.Files = Files;
 Vals.FileRetrieveResponsesPageCursorURL = FileRetrieveResponsesPageCursorURL;
-export { ValsPageCursorURL };
 //# sourceMappingURL=vals.mjs.map

package/resources/vals/vals.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"vals.mjs","sourceRoot":"","sources":["../../src/resources/vals/vals.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,iBAAiB,EAAE;OACrB,KAAK,WAAW;OAChB,EAKL,gCAAgC,EAEhC,QAAQ,GACT;OACM,KAAK,QAAQ;OACb,EAOL,kCAAkC,EAGlC,KAAK,GACN;AAGD;;GAEG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IAArC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgC3D,CAAC;IA9BC;;OAEG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAa,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,KAAoB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAa,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,KAAK,EAAE,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAYD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACzB,IAAI,CAAC,gCAAgC,GAAG,gCAAgC,CAAC;AACzE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;AACnB,IAAI,CAAC,kCAAkC,GAAG,kCAAkC,CAAC;AA6B7E,OAAO,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"vals.mjs","sourceRoot":"","sources":["../../src/resources/vals/vals.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,KAAK,WAAW;OAChB,EAKL,gCAAgC,EAEhC,QAAQ,GACT;OACM,KAAK,QAAQ;OACb,EAOL,kCAAkC,EAGlC,KAAK,GACN;AAED;;GAEG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IAArC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA4D3D,CAAC;IA1DC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAa,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,KAAoB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAa,EAAE,OAA6B;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,KAAK,EAAE,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AA6CD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACzB,IAAI,CAAC,gCAAgC,GAAG,gCAAgC,CAAC;AACzE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;AACnB,IAAI,CAAC,kCAAkC,GAAG,kCAAkC,CAAC"}

package/src/index.ts

@@ -14,7 +14,7 @@ import { Users } from './resources/users';
 import { Alias } from './resources/alias/alias';
 import { Me } from './resources/me/me';
 import { Search } from './resources/search/search';
-import { ValCreateParams, ValListParams, Vals } from './resources/vals/vals';
+import { ValCreateParams, ValListParams, ValListResponse, Vals } from './resources/vals/vals';
 
 export interface ClientOptions {
   /**
@@ -237,7 +237,12 @@ export declare namespace ValTown {
     type SqliteExecuteParams as SqliteExecuteParams,
   };
 
-  export { Vals as Vals, type ValCreateParams as ValCreateParams, type ValListParams as ValListParams };
+  export {
+    Vals as Vals,
+    type ValListResponse as ValListResponse,
+    type ValCreateParams as ValCreateParams,
+    type ValListParams as ValListParams,
+  };
 
   export {
     Emails as Emails,

package/src/resources/alias/username/username.ts

@@ -11,6 +11,13 @@ export class Username extends APIResource {
 
   /**
    * Get basic details about a user, given their username
+   *
+   * @example
+   * ```ts
+   * const user = await client.alias.username.retrieve(
+   *   'username',
+   * );
+   * ```
    */
   retrieve(username: string, options?: Core.RequestOptions): Core.APIPromise<Shared.User> {
     return this._client.get(`/v1/alias/${username}`, options);

package/src/resources/alias/username/val-name.ts

@@ -7,6 +7,14 @@ import * as Shared from '../../shared';
 export class ValName extends APIResource {
   /**
    * Get a val
+   *
+   * @example
+   * ```ts
+   * const val = await client.alias.username.valName.retrieve(
+   *   'username',
+   *   'val_name',
+   * );
+   * ```
    */
   retrieve(username: string, valName: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Val> {
     return this._client.get(`/v2/alias/vals/${username}/${valName}`, options);

package/src/resources/emails.ts

@@ -10,6 +10,15 @@ import * as Core from '../core';
 export class Emails extends APIResource {
   /**
    * Send emails
+   *
+   * @example
+   * ```ts
+   * const response = await client.emails.send({
+   *   html: 'Hello <strong>world</strong>',
+   *   subject: 'An important message',
+   *   text: 'Hello world',
+   * });
+   * ```
    */
   send(body?: EmailSendParams, options?: Core.RequestOptions): Core.APIPromise<EmailSendResponse>;
   send(options?: Core.RequestOptions): Core.APIPromise<EmailSendResponse>;

package/src/resources/index.ts

@@ -8,4 +8,4 @@ export { Me } from './me/me';
 export { Search } from './search/search';
 export { Sqlite, type SqliteBatchResponse, type SqliteBatchParams, type SqliteExecuteParams } from './sqlite';
 export { Users } from './users';
-export { Vals, type ValCreateParams, type ValListParams } from './vals/vals';
+export { Vals, type ValListResponse, type ValCreateParams, type ValListParams } from './vals/vals';

package/src/resources/sqlite.ts

@@ -10,6 +10,14 @@ import * as Shared from './shared';
 export class Sqlite extends APIResource {
   /**
    * Execute a batch of SQLite statements and return results for all of them
+   *
+   * @example
+   * ```ts
+   * const resultSets = await client.sqlite.batch({
+   *   statements: ['SELECT 1;'],
+   *   mode: 'read',
+   * });
+   * ```
    */
   batch(body: SqliteBatchParams, options?: Core.RequestOptions): Core.APIPromise<SqliteBatchResponse> {
     return this._client.post('/v1/sqlite/batch', { body, ...options });
@@ -17,6 +25,13 @@ export class Sqlite extends APIResource {
 
   /**
    * Execute a single SQLite statement and return results
+   *
+   * @example
+   * ```ts
+   * const resultSet = await client.sqlite.execute({
+   *   statement: 'SELECT 1;',
+   * });
+   * ```
    */
   execute(body: SqliteExecuteParams, options?: Core.RequestOptions): Core.APIPromise<Shared.ResultSet> {
     return this._client.post('/v1/sqlite/execute', { body, ...options });

package/src/resources/users.ts

@@ -10,6 +10,13 @@ import * as Shared from './shared';
 export class Users extends APIResource {
   /**
    * Get basic information about a user
+   *
+   * @example
+   * ```ts
+   * const user = await client.users.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   retrieve(userId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.User> {
     return this._client.get(`/v1/users/${userId}`, options);

package/src/resources/vals/branches.ts

@@ -7,6 +7,17 @@ import { PageCursorURL, type PageCursorURLParams } from '../../pagination';
 export class Branches extends APIResource {
   /**
    * Create a new branch
+   *
+   * @example
+   * ```ts
+   * const branch = await client.vals.branches.create(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   {
+   *     name: 'my-branch',
+   *     branchId: '00000000-0000-0000-0000-000000000000',
+   *   },
+   * );
+   * ```
    */
   create(
     valId: string,
@@ -18,6 +29,14 @@ export class Branches extends APIResource {
 
   /**
    * Get a branch by id
+   *
+   * @example
+   * ```ts
+   * const branch = await client.vals.branches.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   retrieve(
     valId: string,
@@ -29,6 +48,17 @@ export class Branches extends APIResource {
 
   /**
    * List all branches for a val
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const branchListResponse of client.vals.branches.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { limit: 1, offset: 0 },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     valId: string,
@@ -43,6 +73,14 @@ export class Branches extends APIResource {
 
   /**
    * Delete a branch
+   *
+   * @example
+   * ```ts
+   * await client.vals.branches.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   '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}`, {

package/src/resources/vals/files.ts

@@ -8,6 +8,14 @@ import { type Response } from '../../_shims/index';
 export class Files extends APIResource {
   /**
    * Create a new file, project val or directory
+   *
+   * @example
+   * ```ts
+   * const file = await client.vals.files.create(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { path: 'path', type: 'directory' },
+   * );
+   * ```
    */
   create(
     valId: string,
@@ -21,6 +29,17 @@ export class Files extends APIResource {
   /**
    * Get metadata for files and directories in a val. If path is an empty string,
    * returns files at the root directory.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const fileRetrieveResponse of client.vals.files.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { limit: 1, offset: 0, path: 'path', recursive: true },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   retrieve(
     valId: string,
@@ -35,6 +54,14 @@ export class Files extends APIResource {
 
   /**
    * Update a file's content
+   *
+   * @example
+   * ```ts
+   * const file = await client.vals.files.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { path: 'path' },
+   * );
+   * ```
    */
   update(
     valId: string,
@@ -49,6 +76,14 @@ export class Files extends APIResource {
    * Deletes a file or a directory. To delete a directory and all of its children,
    * use the recursive flag. To delete all files, pass in an empty path and the
    * recursive flag.
+   *
+   * @example
+   * ```ts
+   * await client.vals.files.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { path: 'path', recursive: true },
+   * );
+   * ```
    */
   delete(valId: string, params: FileDeleteParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     const { path, recursive, branch_id } = params;
@@ -61,6 +96,17 @@ export class Files extends APIResource {
 
   /**
    * Download file content
+   *
+   * @example
+   * ```ts
+   * const response = await client.vals.files.getContent(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { path: 'path' },
+   * );
+   *
+   * const content = await response.blob();
+   * console.log(content);
+   * ```
    */
   getContent(
     valId: string,

package/src/resources/vals/index.ts

@@ -21,4 +21,4 @@ export {
   type FileDeleteParams,
   type FileGetContentParams,
 } from './files';
-export { Vals, type ValCreateParams, type ValListParams } from './vals';
+export { Vals, type ValListResponse, type ValCreateParams, type ValListParams } from './vals';

package/src/resources/vals/vals.ts

@@ -3,7 +3,6 @@
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import * as Shared from '../shared';
-import { ValsPageCursorURL } from '../shared';
 import * as BranchesAPI from './branches';
 import {
   BranchCreateParams,
@@ -27,7 +26,6 @@ import {
   FileUpdateResponse,
   Files,
 } from './files';
-import { type PageCursorURLParams } from '../../pagination';
 
 /**
  * Vals are a collaborative folder of runnable JavaScript, TypeScript, and JSX modules
@@ -38,6 +36,15 @@ export class Vals extends APIResource {
 
   /**
    * Create a new val
+   *
+   * @example
+   * ```ts
+   * const val = await client.vals.create({
+   *   name: 'myVal',
+   *   privacy: 'public',
+   *   description: 'My val',
+   * });
+   * ```
    */
   create(body: ValCreateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Val> {
     return this._client.post('/v2/vals', { body, ...options });
@@ -45,20 +52,39 @@ export class Vals extends APIResource {
 
   /**
    * Get a val by id
+   *
+   * @example
+   * ```ts
+   * const val = await client.vals.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   retrieve(valId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Val> {
     return this._client.get(`/v2/vals/${valId}`, options);
   }
 
   /**
-   * Lists all public vals
+   * Lists all vals including all public vals and your unlisted and private vals
+   *
+   * @example
+   * ```ts
+   * const vals = await client.vals.list({ limit: 1 });
+   * ```
    */
-  list(query: ValListParams, options?: Core.RequestOptions): Core.PagePromise<ValsPageCursorURL, Shared.Val> {
-    return this._client.getAPIList('/v2/vals', ValsPageCursorURL, { query, ...options });
+  list(query: ValListParams, options?: Core.RequestOptions): Core.APIPromise<ValListResponse> {
+    return this._client.get('/v2/vals', { query, ...options });
   }
 
   /**
    * Delete a project
+   *
+   * @example
+   * ```ts
+   * await client.vals.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   delete(valId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/v2/vals/${valId}`, {
@@ -68,6 +94,18 @@ 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;
 
@@ -76,7 +114,28 @@ export interface ValCreateParams {
   description?: string;
 }
 
-export interface ValListParams extends PageCursorURLParams {}
+export interface ValListParams {
+  /**
+   * 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.
+   */
+  privacy?: 'public' | 'unlisted' | 'private';
+
+  /**
+   * User ID to filter by
+   */
+  user_id?: string;
+}
 
 Vals.Branches = Branches;
 Vals.BranchListResponsesPageCursorURL = BranchListResponsesPageCursorURL;
@@ -84,7 +143,11 @@ Vals.Files = Files;
 Vals.FileRetrieveResponsesPageCursorURL = FileRetrieveResponsesPageCursorURL;
 
 export declare namespace Vals {
-  export { type ValCreateParams as ValCreateParams, type ValListParams as ValListParams };
+  export {
+    type ValListResponse as ValListResponse,
+    type ValCreateParams as ValCreateParams,
+    type ValListParams as ValListParams,
+  };
 
   export {
     Branches as Branches,
@@ -109,5 +172,3 @@ export declare namespace Vals {
     type FileGetContentParams as FileGetContentParams,
   };
 }
-
-export { ValsPageCursorURL };

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.1.0'; // x-release-please-version
+export const VERSION = '1.2.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.1.0";
+export declare const VERSION = "1.2.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 = '1.1.0'; // x-release-please-version
+exports.VERSION = '1.2.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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