@valtown/sdk 1.1.0 → 1.3.0

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.3.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.3.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.3.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.3.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map