@valtown/sdk 0.26.0 → 0.28.0

package/src/index.ts

@@ -12,6 +12,13 @@ import { EmailSendParams, EmailSendResponse, Emails } from './resources/emails';
 import { Sqlite, SqliteBatchParams, SqliteBatchResponse, SqliteExecuteParams } from './resources/sqlite';
 import { Alias } from './resources/alias/alias';
 import { Me } from './resources/me/me';
+import {
+  ProjectListParams,
+  ProjectListResponse,
+  ProjectListResponsesPageCursorURL,
+  ProjectRetrieveResponse,
+  Projects,
+} from './resources/projects/projects';
 import { Search } from './resources/search/search';
 import { Users } from './resources/users/users';
 import {
@@ -167,6 +174,10 @@ export class ValTown extends Core.APIClient {
    * Val Town supports sending emails from vals
    */
   emails: API.Emails = new API.Emails(this);
+  /**
+   * Projects let you organize multiple files and collaborate with pull requests
+   */
+  projects: API.Projects = new API.Projects(this);
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
@@ -212,6 +223,8 @@ ValTown.Users = Users;
 ValTown.Sqlite = Sqlite;
 ValTown.Vals = Vals;
 ValTown.Emails = Emails;
+ValTown.Projects = Projects;
+ValTown.ProjectListResponsesPageCursorURL = ProjectListResponsesPageCursorURL;
 export declare namespace ValTown {
   export type RequestOptions = Core.RequestOptions;
 
@@ -257,6 +270,14 @@ export declare namespace ValTown {
     type EmailSendParams as EmailSendParams,
   };
 
+  export {
+    Projects as Projects,
+    type ProjectRetrieveResponse as ProjectRetrieveResponse,
+    type ProjectListResponse as ProjectListResponse,
+    ProjectListResponsesPageCursorURL as ProjectListResponsesPageCursorURL,
+    type ProjectListParams as ProjectListParams,
+  };
+
   export type BasicVal = API.BasicVal;
   export type ExtendedVal = API.ExtendedVal;
   export type PaginationLinks = API.PaginationLinks;

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

@@ -50,8 +50,8 @@ export interface ValNameRetrieveResponse {
   name: string;
 
   /**
-   * This val’s privacy setting. Unlisted vals do not appear on profile pages or
-   * elsewhere, but you can link to them.
+   * 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';
 
@@ -74,7 +74,7 @@ export interface ValNameRetrieveResponse {
   type: 'interval' | 'http' | 'express' | 'email' | 'script' | 'rpc' | 'httpnext';
 
   /**
-   * The URL of this val on the Val Town website
+   * The URL of this resource on the Val Town website
    */
   url: string;
 

package/src/resources/index.ts

@@ -5,6 +5,13 @@ export { Alias } from './alias/alias';
 export { Blobs, type BlobListResponse, type BlobListParams, type BlobStoreParams } from './blobs';
 export { Emails, type EmailSendResponse, type EmailSendParams } from './emails';
 export { Me } from './me/me';
+export {
+  ProjectListResponsesPageCursorURL,
+  Projects,
+  type ProjectRetrieveResponse,
+  type ProjectListResponse,
+  type ProjectListParams,
+} from './projects/projects';
 export { Search } from './search/search';
 export { Sqlite, type SqliteBatchResponse, type SqliteBatchParams, type SqliteExecuteParams } from './sqlite';
 export { Users } from './users/users';

package/src/resources/me/comments.ts

@@ -60,8 +60,8 @@ export namespace CommentListResponse {
     name: string;
 
     /**
-     * This val’s privacy setting. Unlisted vals do not appear on profile pages or
-     * elsewhere, but you can link to them.
+     * 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';
 

package/src/resources/projects/branches.ts

@@ -0,0 +1,103 @@
+// 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 Branches extends APIResource {
+  /**
+   * [BETA] Get a branch by id
+   */
+  retrieve(
+    projectId: string,
+    branchId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BranchRetrieveResponse> {
+    return this._client.get(`/v1/projects/${projectId}/branches/${branchId}`, options);
+  }
+
+  /**
+   * [BETA] List all branches for a project
+   */
+  list(
+    projectId: string,
+    query: BranchListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BranchListResponsesPageCursorURL, BranchListResponse> {
+    return this._client.getAPIList(`/v1/projects/${projectId}/branches`, BranchListResponsesPageCursorURL, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export class BranchListResponsesPageCursorURL extends PageCursorURL<BranchListResponse> {}
+
+/**
+ * A Branch
+ */
+export interface BranchRetrieveResponse {
+  /**
+   * The id of the branch
+   */
+  id: string;
+
+  createdAt: string;
+
+  /**
+   * The id of the branch this branch was forked from
+   */
+  forkedBranchId: string | null;
+
+  name: string;
+
+  updatedAt: string;
+
+  /**
+   * The URL of this resource on the Val Town website
+   */
+  valTownUrl: string;
+
+  version: number;
+}
+
+/**
+ * A Branch
+ */
+export interface BranchListResponse {
+  /**
+   * The id of the branch
+   */
+  id: string;
+
+  createdAt: string;
+
+  /**
+   * The id of the branch this branch was forked from
+   */
+  forkedBranchId: string | null;
+
+  name: string;
+
+  updatedAt: string;
+
+  /**
+   * The URL of this resource on the Val Town website
+   */
+  valTownUrl: string;
+
+  version: number;
+}
+
+export interface BranchListParams extends PageCursorURLParams {}
+
+Branches.BranchListResponsesPageCursorURL = BranchListResponsesPageCursorURL;
+
+export declare namespace Branches {
+  export {
+    type BranchRetrieveResponse as BranchRetrieveResponse,
+    type BranchListResponse as BranchListResponse,
+    BranchListResponsesPageCursorURL as BranchListResponsesPageCursorURL,
+    type BranchListParams as BranchListParams,
+  };
+}

package/src/resources/projects/index.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  BranchListResponsesPageCursorURL,
+  Branches,
+  type BranchRetrieveResponse,
+  type BranchListResponse,
+  type BranchListParams,
+} from './branches';
+export {
+  ProjectListResponsesPageCursorURL,
+  Projects,
+  type ProjectRetrieveResponse,
+  type ProjectListResponse,
+  type ProjectListParams,
+} from './projects';

package/src/resources/projects/projects.ts

@@ -0,0 +1,146 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as BranchesAPI from './branches';
+import {
+  BranchListParams,
+  BranchListResponse,
+  BranchListResponsesPageCursorURL,
+  BranchRetrieveResponse,
+  Branches,
+} from './branches';
+import { PageCursorURL, type PageCursorURLParams } from '../../pagination';
+
+/**
+ * Projects let you organize multiple files and collaborate with pull requests
+ */
+export class Projects extends APIResource {
+  branches: BranchesAPI.Branches = new BranchesAPI.Branches(this._client);
+
+  /**
+   * [BETA] Get a project by id
+   */
+  retrieve(projectId: string, options?: Core.RequestOptions): Core.APIPromise<ProjectRetrieveResponse> {
+    return this._client.get(`/v1/projects/${projectId}`, options);
+  }
+
+  /**
+   * [BETA] List all of a user's projects for authenticated users
+   */
+  list(
+    query: ProjectListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ProjectListResponsesPageCursorURL, ProjectListResponse> {
+    return this._client.getAPIList('/v1/projects', ProjectListResponsesPageCursorURL, { query, ...options });
+  }
+}
+
+export class ProjectListResponsesPageCursorURL extends PageCursorURL<ProjectListResponse> {}
+
+/**
+ * A Project
+ */
+export interface ProjectRetrieveResponse {
+  /**
+   * The id of the project
+   */
+  id: string;
+
+  author: ProjectRetrieveResponse.Author;
+
+  createdAt: string;
+
+  description: string | null;
+
+  /**
+   * The URL of this project's image
+   */
+  imageUrl: string | null;
+
+  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';
+
+  /**
+   * The URL of this resource on the Val Town website
+   */
+  valTownUrl: string;
+}
+
+export namespace ProjectRetrieveResponse {
+  export interface Author {
+    id: string;
+
+    username: string | null;
+  }
+}
+
+/**
+ * A Project
+ */
+export interface ProjectListResponse {
+  /**
+   * The id of the project
+   */
+  id: string;
+
+  author: ProjectListResponse.Author;
+
+  createdAt: string;
+
+  description: string | null;
+
+  /**
+   * The URL of this project's image
+   */
+  imageUrl: string | null;
+
+  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';
+
+  /**
+   * The URL of this resource on the Val Town website
+   */
+  valTownUrl: string;
+}
+
+export namespace ProjectListResponse {
+  export interface Author {
+    id: string;
+
+    username: string | null;
+  }
+}
+
+export interface ProjectListParams extends PageCursorURLParams {}
+
+Projects.ProjectListResponsesPageCursorURL = ProjectListResponsesPageCursorURL;
+Projects.Branches = Branches;
+Projects.BranchListResponsesPageCursorURL = BranchListResponsesPageCursorURL;
+
+export declare namespace Projects {
+  export {
+    type ProjectRetrieveResponse as ProjectRetrieveResponse,
+    type ProjectListResponse as ProjectListResponse,
+    ProjectListResponsesPageCursorURL as ProjectListResponsesPageCursorURL,
+    type ProjectListParams as ProjectListParams,
+  };
+
+  export {
+    Branches as Branches,
+    type BranchRetrieveResponse as BranchRetrieveResponse,
+    type BranchListResponse as BranchListResponse,
+    BranchListResponsesPageCursorURL as BranchListResponsesPageCursorURL,
+    type BranchListParams as BranchListParams,
+  };
+}

package/src/resources/shared.ts

@@ -31,8 +31,8 @@ export interface BasicVal {
   name: string;
 
   /**
-   * This val’s privacy setting. Unlisted vals do not appear on profile pages or
-   * elsewhere, but you can link to them.
+   * 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';
 
@@ -48,7 +48,7 @@ export interface BasicVal {
   type: 'interval' | 'http' | 'express' | 'email' | 'script' | 'rpc' | 'httpnext';
 
   /**
-   * The URL of this val on the Val Town website
+   * The URL of this resource on the Val Town website
    */
   url: string;
 
@@ -125,8 +125,8 @@ export interface ExtendedVal {
   name: string;
 
   /**
-   * This val’s privacy setting. Unlisted vals do not appear on profile pages or
-   * elsewhere, but you can link to them.
+   * 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';
 
@@ -149,7 +149,7 @@ export interface ExtendedVal {
   type: 'interval' | 'http' | 'express' | 'email' | 'script' | 'rpc' | 'httpnext';
 
   /**
-   * The URL of this val on the Val Town website
+   * The URL of this resource on the Val Town website
    */
   url: string;
 

package/src/resources/vals/vals.ts

@@ -110,8 +110,8 @@ export interface ValCreateParams {
   name?: string;
 
   /**
-   * This val’s privacy setting. Unlisted vals do not appear on profile pages or
-   * elsewhere, but you can link to them.
+   * 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';
 
@@ -134,8 +134,8 @@ export interface ValUpdateParams {
   name?: string;
 
   /**
-   * This val’s privacy setting. Unlisted vals do not appear on profile pages or
-   * elsewhere, but you can link to them.
+   * 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';
 

package/src/resources/vals/versions.ts

@@ -82,8 +82,8 @@ export interface VersionCreateParams {
   name?: string;
 
   /**
-   * This val’s privacy setting. Unlisted vals do not appear on profile pages or
-   * elsewhere, but you can link to them.
+   * 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';
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.26.0'; // x-release-please-version
+export const VERSION = '0.28.0'; // x-release-please-version

package/version.d.ts

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

package/version.mjs

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