@superblocksteam/sdk-api 0.0.6 → 0.0.8

package/src/integrations/base/types.ts

@@ -3,8 +3,38 @@
  */
 
 import type { z } from "zod";
+
 import type { TraceMetadata } from "../registry.js";
 
+// Re-export for backwards compatibility
+export type { TraceMetadata };
+
+/**
+ * How the orchestrator should decode the HTTP response body.
+ *
+ * - `"json"` (default): parse the response as JSON; fails on non-JSON bodies
+ * - `"text"`: return the decoded response body as a string (XML, CSV, HTML, ...)
+ *
+ * The orchestrator also implements `"auto"`, `"binary"`, and `"raw"` wire
+ * values; they are deliberately not exposed here (widening this union later
+ * is backward-compatible, narrowing it is not):
+ *
+ * - `"auto"` returns parsed JSON whenever the body happens to parse, which
+ *   would let JSON responses bypass schema validation via the schema-less
+ *   overload
+ * - `"binary"` would freeze the worker's internal Buffer JSON encoding
+ *   (`{ type: "Buffer", data: number[] }`, ~4x payload inflation) into the
+ *   public SDK contract
+ * - `"raw"` is rejected by the orchestrator for non-streaming requests
+ *
+ * The runtime tuple backs the request-time guard in `executeApiRequest`:
+ * the type-level union is erased in the bundled JS user APIs run as, so
+ * values outside it must also be rejected at runtime.
+ */
+export const REST_API_RESPONSE_TYPES = ["json", "text"] as const;
+
+export type RestApiResponseType = (typeof REST_API_RESPONSE_TYPES)[number];
+
 /**
  * Options for making a generic REST API request.
  */
@@ -34,6 +64,15 @@ export interface ApiRequestOptions<TBody = unknown> {
    * Optional HTTP headers
    */
   headers?: Record<string, string>;
+
+  /**
+   * How the response body should be decoded. Defaults to `"json"`.
+   *
+   * Use `"text"` for endpoints that return non-JSON payloads such as
+   * XML. When requesting a text response, omit the response schema (or
+   * use one matching the decoded string, e.g. `z.string()`).
+   */
+  responseType?: RestApiResponseType;
 }
 
 /**
@@ -42,7 +81,7 @@ export interface ApiRequestOptions<TBody = unknown> {
 export interface ApiRequestSchema<TBody = unknown, TResponse = unknown> {
   /**
    * Optional Zod schema for request body validation.
-   * Required if body is provided in options.
+   * When omitted, `options.body` is sent without validation.
    */
   body?: z.ZodSchema<TBody>;
 
@@ -56,14 +95,18 @@ export interface ApiRequestSchema<TBody = unknown, TResponse = unknown> {
 /**
  * Interface for integration clients that support generic API requests.
  *
- * All API requests require response schema validation for type safety.
+ * Providing a response schema gives type-safe, validated results. Omitting
+ * it returns the raw response as `unknown`. For non-JSON payloads (e.g.
+ * `responseType: "text"` for XML), either omit the schema or supply one
+ * matching the decoded value (e.g. `z.string()` for text) — object schemas
+ * only make sense for JSON-shaped results.
  */
 export interface SupportsApiRequest {
   /**
    * Execute a generic API request with type-safe validation.
    *
    * @param options - Request configuration including method, path, params, and body
-   * @param schema - Zod schemas for request body and response validation (response schema REQUIRED)
+   * @param schema - Zod schemas for request body and response validation
    * @param metadata - Optional trace metadata for observability (label, description)
    * @returns Validated response data
    *
@@ -99,78 +142,39 @@ export interface SupportsApiRequest {
     },
     metadata?: TraceMetadata,
   ): Promise<TResponse>;
-}
 
-/**
- * Schema configuration for streaming API request validation.
- */
-export interface StreamApiRequestSchema<TBody = unknown, TChunk = unknown> {
   /**
-   * Optional Zod schema for request body validation.
-   * Required if body is provided in options.
-   */
-  body?: z.ZodSchema<TBody>;
-
-  /**
-   * Zod schema for validating each streamed chunk.
+   * Execute a generic API request without response validation.
    *
-   * Every chunk received from the stream is validated against this schema.
-   * Validation errors will terminate the stream.
-   */
-  chunk: z.ZodSchema<TChunk>;
-}
-
-/**
- * Interface for integration clients that support streaming API requests.
- *
- * Streaming API requests return an AsyncIterable of validated chunks,
- * enabling real-time data streaming from LLMs and other sources.
- */
-export interface SupportsStreamingApiRequest {
-  /**
-   * Execute a streaming API request with type-safe chunk validation.
+   * This overload requires an explicit non-JSON `responseType` — JSON
+   * responses must always be consumed through the schema overload above,
+   * so "unvalidated JSON" is unrepresentable. The decoded non-JSON
+   * response is returned as-is, typed `unknown`.
    *
-   * Returns an AsyncIterable that yields validated chunks as they arrive.
-   * Each chunk is validated against the provided schema before being yielded.
+   * Note: request-body validation is opt-in — it runs only when
+   * `schema.body` is provided. Omitting `schema` sends `options.body`
+   * without validation.
    *
-   * @param options - Request configuration including method, path, params, and body
-   * @param schema - Zod schemas for request body and chunk validation (chunk schema REQUIRED)
+   * @param options - Request configuration; `responseType` must be "text"
+   * @param schema - Optional Zod schema for request body validation
    * @param metadata - Optional trace metadata for observability (label, description)
-   * @returns AsyncIterable yielding validated chunks
+   * @returns The raw response from the integration
    *
    * @example
    * ```typescript
-   * const ChunkSchema = z.object({
-   *   id: z.string(),
-   *   choices: z.array(z.object({
-   *     delta: z.object({
-   *       content: z.string().optional(),
-   *     }),
-   *   })),
+   * const xml = await ctx.integrations.legacyApi.apiRequest({
+   *   method: 'GET',
+   *   path: '/report.xml',
+   *   responseType: 'text',
    * });
-   *
-   * const stream = client.streamApiRequest(
-   *   {
-   *     method: 'POST',
-   *     path: '/v1/chat/completions',
-   *     body: {
-   *       model: 'gpt-4',
-   *       stream: true,
-   *       messages: [{ role: 'user', content: 'Hello!' }],
-   *     },
-   *   },
-   *   { chunk: ChunkSchema },
-   *   { label: 'openai.chatCompletions', description: 'Stream chat completion' }
-   * );
-   *
-   * for await (const chunk of stream) {
-   *   console.log(chunk.choices[0]?.delta?.content);
-   * }
+   * // xml is the raw XML string
    * ```
    */
-  streamApiRequest<TBody, TChunk>(
-    options: ApiRequestOptions<TBody>,
-    schema: StreamApiRequestSchema<TBody, TChunk>,
+  apiRequest<TBody>(
+    options: ApiRequestOptions<TBody> & {
+      responseType: Exclude<RestApiResponseType, "json">;
+    },
+    schema?: ApiRequestSchema<TBody, unknown>,
     metadata?: TraceMetadata,
-  ): AsyncIterable<TChunk>;
+  ): Promise<unknown>;
 }

package/src/integrations/bigquery/README.md

@@ -40,7 +40,7 @@ export default api({
     const events = await ctx.integrations.bigquery.query(
       `SELECT event_id, event_name, user_id, timestamp
        FROM \`project.dataset.events\`
-       WHERE event_name = $1
+       WHERE event_name = ?
        LIMIT 100`,
       EventSchema,
       [event_name],
@@ -51,12 +51,16 @@ export default api({
 });
 ```
 
+The SDK currently binds BigQuery parameters from the positional `params` array.
+Even though native BigQuery also supports named parameters like `@event_name`,
+use `?` placeholders in SDK queries and pass values in array order.
+
 ### Executing INSERT, UPDATE, DELETE Statements
 
 ```typescript
 // INSERT
 await ctx.integrations.bigquery.execute(
-  "INSERT INTO `project.dataset.metrics` (name, value, timestamp) VALUES ($1, $2, CURRENT_TIMESTAMP())",
+  "INSERT INTO `project.dataset.metrics` (name, value, timestamp) VALUES (?, ?, CURRENT_TIMESTAMP())",
   ["cpu_usage", "75.5"],
 );
 ```
@@ -116,6 +120,27 @@ All methods accept an optional `metadata` parameter as the last argument for dia
 
 ## Common Pitfalls
 
+### SDK Parameters Are Positional
+
+The SDK accepts an array of parameter values and binds them server-side in
+order. When you need parameters, use `?` placeholders in the SQL text:
+
+```typescript
+// WRONG - Native BigQuery named parameter syntax is not the SDK contract
+await ctx.integrations.bigquery.query(
+  "SELECT * FROM `project.dataset.events` WHERE event_name = @event_name",
+  EventSchema,
+  ["signup"],
+);
+
+// CORRECT - Use positional params with ? placeholders
+await ctx.integrations.bigquery.query(
+  "SELECT * FROM `project.dataset.events` WHERE event_name = ?",
+  EventSchema,
+  ["signup"],
+);
+```
+
 ### Backtick Table References
 
 BigQuery uses backticks for fully-qualified table names:
@@ -165,7 +190,7 @@ BigQuery charges by data scanned. Use partitions and column selection:
 const query = `
   SELECT event_id, event_name
   FROM \`project.dataset.events\`
-  WHERE _PARTITIONDATE = $1
+  WHERE _PARTITIONDATE = ?
 `;
 ```
 

package/src/integrations/bigquery/client.ts

@@ -5,13 +5,15 @@
  * runtime validation using Zod schemas.
  */
 
-import type { z } from "zod";
 import type { PartialMessage } from "@bufbuild/protobuf";
+import type { z } from "zod";
+
 import type { Plugin as BigQueryPlugin } from "@superblocksteam/types/dist/src/plugins/bigquery/v1/plugin_pb";
-import type { IntegrationConfig, IntegrationClientImpl } from "../types.js";
-import type { QueryExecutor, TraceMetadata } from "../registry.js";
+
 import { QueryValidationError } from "../../errors.js";
 import { IntegrationError } from "../../runtime/errors.js";
+import type { QueryExecutor, TraceMetadata } from "../registry.js";
+import type { IntegrationConfig, IntegrationClientImpl } from "../types.js";
 import { describeType } from "../utils.js";
 import type { BigQueryClient } from "./types.js";
 

package/src/integrations/bigquery/docs.manifest.json

@@ -0,0 +1,5 @@
+{
+  "pluginId": "bigquery",
+  "base": "README.md",
+  "overlays": []
+}

package/src/integrations/bigquery/types.ts

@@ -5,6 +5,7 @@
  */
 
 import type { z } from "zod";
+
 import type { BaseIntegrationClient } from "../../types.js";
 import type { TraceMetadata } from "../registry.js";
 
@@ -24,7 +25,7 @@ import type { TraceMetadata } from "../registry.js";
  * });
  *
  * const events = await bigquery.query(
- *   'SELECT * FROM events WHERE date = $1',
+ *   'SELECT * FROM events WHERE date = ?',
  *   EventSchema,
  *   ['2024-01-01']
  * );
@@ -34,9 +35,9 @@ export interface BigQueryClient extends BaseIntegrationClient {
   /**
    * Execute a SQL query and validate results against a Zod schema.
    *
-   * @param sql - SQL query string (use $1, $2, etc. for parameters)
+   * @param sql - SQL query string (use ? placeholders for parameters)
    * @param schema - Zod schema to validate the query results
-   * @param params - Optional query parameters
+   * @param params - Optional query parameters, bound positionally from the provided array
    * @returns Promise resolving to validated query results
    *
    * @throws {QueryValidationError} If results don't match schema

package/src/integrations/bitbucket/README.md

@@ -54,7 +54,7 @@ export default api({
     const result = await ctx.integrations.bitbucket.apiRequest(
       {
         method: "GET",
-        path: `/2.0/repositories/${workspace}`,
+        path: `/repositories/${workspace}`,
         params: {
           pagelen: 50,
         },
@@ -78,7 +78,7 @@ export default api({
 const repo = await ctx.integrations.bitbucket.apiRequest(
   {
     method: "GET",
-    path: `/2.0/repositories/${workspace}/${repoSlug}`,
+    path: `/repositories/${workspace}/${repoSlug}`,
   },
   { response: RepositorySchema },
 );
@@ -111,7 +111,7 @@ const PullRequestSchema = z.object({
 const pr = await ctx.integrations.bitbucket.apiRequest(
   {
     method: "POST",
-    path: `/2.0/repositories/${workspace}/${repoSlug}/pullrequests`,
+    path: `/repositories/${workspace}/${repoSlug}/pullrequests`,
     body: {
       title: "Add new feature",
       description: "This PR adds...",
@@ -143,7 +143,7 @@ const ListPRsResponseSchema = z.object({
 const result = await ctx.integrations.bitbucket.apiRequest(
   {
     method: "GET",
-    path: `/2.0/repositories/${workspace}/${repoSlug}/pullrequests`,
+    path: `/repositories/${workspace}/${repoSlug}/pullrequests`,
     params: {
       state: "OPEN", // OPEN, MERGED, DECLINED, SUPERSEDED
       pagelen: 25,
@@ -172,7 +172,7 @@ const MergeResponseSchema = z.object({
 const result = await ctx.integrations.bitbucket.apiRequest(
   {
     method: "POST",
-    path: `/2.0/repositories/${workspace}/${repoSlug}/pullrequests/${prId}/merge`,
+    path: `/repositories/${workspace}/${repoSlug}/pullrequests/${prId}/merge`,
     body: {
       type: "pullrequest",
       message: "Merge pull request #123",
@@ -209,7 +209,7 @@ const ListCommitsResponseSchema = z.object({
 const result = await ctx.integrations.bitbucket.apiRequest(
   {
     method: "GET",
-    path: `/2.0/repositories/${workspace}/${repoSlug}/commits`,
+    path: `/repositories/${workspace}/${repoSlug}/commits`,
     params: {
       branch: "main",
       pagelen: 10,
@@ -232,7 +232,7 @@ const BranchSchema = z.object({
 const branch = await ctx.integrations.bitbucket.apiRequest(
   {
     method: "POST",
-    path: `/2.0/repositories/${workspace}/${repoSlug}/refs/branches`,
+    path: `/repositories/${workspace}/${repoSlug}/refs/branches`,
     body: {
       name: "feature/new-feature",
       target: {
@@ -251,7 +251,7 @@ const branch = await ctx.integrations.bitbucket.apiRequest(
 const content = await ctx.integrations.bitbucket.apiRequest(
   {
     method: "GET",
-    path: `/2.0/repositories/${workspace}/${repoSlug}/src/main/README.md`,
+    path: `/repositories/${workspace}/${repoSlug}/src/main/README.md`,
   },
   { response: z.string() },
 );
@@ -274,7 +274,7 @@ const CommentSchema = z.object({
 const comment = await ctx.integrations.bitbucket.apiRequest(
   {
     method: "POST",
-    path: `/2.0/repositories/${workspace}/${repoSlug}/pullrequests/${prId}/comments`,
+    path: `/repositories/${workspace}/${repoSlug}/pullrequests/${prId}/comments`,
     body: {
       content: {
         raw: "LGTM! :+1:",
@@ -300,20 +300,20 @@ await bitbucket.listRepos();
 
 // CORRECT - Use apiRequest
 await ctx.integrations.bitbucket.apiRequest(
-  { method: "POST", path: `/2.0/repositories/${workspace}/${repo}/pullrequests`, body: { ... } },
+  { method: "POST", path: `/repositories/${workspace}/${repo}/pullrequests`, body: { ... } },
   { response: PullRequestSchema }
 );
 ```
 
 ### API Version in Path
 
-Always include `/2.0/` prefix:
+The base URL already includes `/2.0`, so do not repeat it in paths:
 
 ```typescript
-// WRONG - Missing version
+// CORRECT - No version prefix (base URL already has /2.0)
 const path = `/repositories/${workspace}/${repo}`;
 
-// CORRECT - Include version
+// WRONG - Duplicates version from base URL
 const path = `/2.0/repositories/${workspace}/${repo}`;
 ```
 
@@ -323,10 +323,10 @@ Use workspace slug for API calls:
 
 ```typescript
 // Workspace slug (preferred)
-const path = `/2.0/repositories/myworkspace/myrepo`;
+const path = `/repositories/myworkspace/myrepo`;
 
 // Can also be username for personal repos
-const path = `/2.0/repositories/myusername/myrepo`;
+const path = `/repositories/myusername/myrepo`;
 ```
 
 ### Pagination
@@ -340,7 +340,7 @@ async function getAllPRs(
   repo: string,
 ) {
   const allPRs: PullRequest[] = [];
-  let url = `/2.0/repositories/${workspace}/${repo}/pullrequests`;
+  let url = `/repositories/${workspace}/${repo}/pullrequests`;
 
   while (url) {
     const result = await ctx.integrations.bitbucket.apiRequest(
@@ -385,7 +385,7 @@ Branch names with slashes need encoding:
 ```typescript
 // Branch name: feature/my-feature
 const branchName = encodeURIComponent("feature/my-feature");
-const path = `/2.0/repositories/${workspace}/${repo}/src/${branchName}/file.txt`;
+const path = `/repositories/${workspace}/${repo}/src/${branchName}/file.txt`;
 ```
 
 ### Raw File Content
@@ -397,7 +397,7 @@ File content endpoints return raw text, not JSON:
 const content = await ctx.integrations.bitbucket.apiRequest(
   {
     method: "GET",
-    path: `/2.0/repositories/${workspace}/${repo}/src/main/file.txt`,
+    path: `/repositories/${workspace}/${repo}/src/main/file.txt`,
   },
   { response: z.string() }, // Not a JSON schema
 );
@@ -410,7 +410,7 @@ import { RestApiValidationError } from "@superblocksteam/sdk-api";
 
 try {
   const result = await ctx.integrations.bitbucket.apiRequest(
-    { method: "GET", path: `/2.0/repositories/${workspace}/${repo}` },
+    { method: "GET", path: `/repositories/${workspace}/${repo}` },
     { response: RepositorySchema },
   );
 } catch (error) {

package/src/integrations/bitbucket/docs.manifest.json

@@ -0,0 +1,5 @@
+{
+  "pluginId": "bitbucket",
+  "base": "README.md",
+  "overlays": []
+}

package/src/integrations/box/README.md

@@ -75,7 +75,7 @@ export default api({
     const result = await ctx.integrations.box.apiRequest(
       {
         method: "GET",
-        path: `/2.0/folders/${folderId}/items`,
+        path: `/folders/${folderId}/items`,
         params: {
           limit: limit,
           offset: 0,
@@ -133,7 +133,7 @@ const FileInfoSchema = z.object({
 const file = await ctx.integrations.box.apiRequest(
   {
     method: "GET",
-    path: `/2.0/files/${fileId}`,
+    path: `/files/${fileId}`,
     params: {
       fields:
         "id,name,size,created_at,modified_at,created_by,modified_by,parent,sha1,shared_link",
@@ -154,7 +154,7 @@ const DownloadUrlResponseSchema = z.string();
 const content = await ctx.integrations.box.apiRequest(
   {
     method: "GET",
-    path: `/2.0/files/${fileId}/content`,
+    path: `/files/${fileId}/content`,
   },
   { response: DownloadUrlResponseSchema },
 );
@@ -172,7 +172,7 @@ const UploadResponseSchema = z.object({
 const result = await ctx.integrations.box.apiRequest(
   {
     method: "POST",
-    path: "/2.0/files/content",
+    path: "/files/content",
     headers: {
       "Content-Type": "multipart/form-data",
     },
@@ -209,7 +209,7 @@ const FolderInfoSchema = z.object({
 const folder = await ctx.integrations.box.apiRequest(
   {
     method: "POST",
-    path: "/2.0/folders",
+    path: "/folders",
     body: {
       name: "New Folder",
       parent: {
@@ -229,7 +229,7 @@ console.log(`Created folder: ${folder.name} (${folder.id})`);
 const copiedFile = await ctx.integrations.box.apiRequest(
   {
     method: "POST",
-    path: `/2.0/files/${fileId}/copy`,
+    path: `/files/${fileId}/copy`,
     body: {
       parent: {
         id: destinationFolderId,
@@ -247,7 +247,7 @@ const copiedFile = await ctx.integrations.box.apiRequest(
 const movedFile = await ctx.integrations.box.apiRequest(
   {
     method: "PUT",
-    path: `/2.0/files/${fileId}`,
+    path: `/files/${fileId}`,
     body: {
       parent: {
         id: newParentFolderId,
@@ -264,7 +264,7 @@ const movedFile = await ctx.integrations.box.apiRequest(
 const updatedFile = await ctx.integrations.box.apiRequest(
   {
     method: "PUT",
-    path: `/2.0/files/${fileId}`,
+    path: `/files/${fileId}`,
     body: {
       name: "renamed-file.txt",
       description: "Updated file description",
@@ -281,7 +281,7 @@ const updatedFile = await ctx.integrations.box.apiRequest(
 await ctx.integrations.box.apiRequest(
   {
     method: "DELETE",
-    path: `/2.0/files/${fileId}`,
+    path: `/files/${fileId}`,
   },
   { response: z.void() },
 );
@@ -304,7 +304,7 @@ const SharedLinkSchema = z.object({
 const file = await ctx.integrations.box.apiRequest(
   {
     method: "PUT",
-    path: `/2.0/files/${fileId}`,
+    path: `/files/${fileId}`,
     params: {
       fields: "shared_link",
     },
@@ -337,7 +337,7 @@ const SearchResponseSchema = z.object({
 const result = await ctx.integrations.box.apiRequest(
   {
     method: "GET",
-    path: "/2.0/search",
+    path: "/search",
     params: {
       query: "quarterly report",
       type: "file",
@@ -372,7 +372,7 @@ const CommentSchema = z.object({
 const comment = await ctx.integrations.box.apiRequest(
   {
     method: "POST",
-    path: "/2.0/comments",
+    path: "/comments",
     body: {
       item: {
         type: "file",
@@ -400,22 +400,22 @@ await box.uploadFile({ ... });
 
 // CORRECT - Use apiRequest
 await ctx.integrations.box.apiRequest(
-  { method: "GET", path: `/2.0/folders/${folderId}/items`, params: { ... } },
+  { method: "GET", path: `/folders/${folderId}/items`, params: { ... } },
   { response: ListItemsResponseSchema }
 );
 ```
 
 ### API Version in Path
 
-Box API paths include version:
+The base URL already includes `/2.0`, so do not repeat it in paths:
 
 ```typescript
-// CORRECT - Include version
-const path = "/2.0/files/123";
-const path = "/2.0/folders/0/items";
-
-// WRONG - Missing version
+// CORRECT - No version prefix (base URL already has /2.0)
 const path = "/files/123";
+const path = "/folders/0/items";
+
+// WRONG - Duplicates version from base URL
+const path = "/2.0/files/123";
 ```
 
 ### Root Folder ID is "0"
@@ -437,7 +437,7 @@ Use `fields` to get specific data:
 ```typescript
 // Without fields, you get minimal data
 const result = await ctx.integrations.box.apiRequest(
-  { method: "GET", path: `/2.0/files/${fileId}` },
+  { method: "GET", path: `/files/${fileId}` },
   { response: FileSchema },
 );
 
@@ -445,7 +445,7 @@ const result = await ctx.integrations.box.apiRequest(
 const result = await ctx.integrations.box.apiRequest(
   {
     method: "GET",
-    path: `/2.0/files/${fileId}`,
+    path: `/files/${fileId}`,
     params: {
       fields: "id,name,size,created_at,modified_at,parent,shared_link",
     },
@@ -477,7 +477,7 @@ Use `If-Match` with etag for safe updates:
 const result = await ctx.integrations.box.apiRequest(
   {
     method: "PUT",
-    path: `/2.0/files/${fileId}`,
+    path: `/files/${fileId}`,
     headers: {
       "If-Match": file.etag, // Prevents overwriting concurrent changes
     },
@@ -503,7 +503,7 @@ async function getAllItems(box: BoxClient, folderId: string) {
     const result = await ctx.integrations.box.apiRequest(
       {
         method: "GET",
-        path: `/2.0/folders/${folderId}/items`,
+        path: `/folders/${folderId}/items`,
         params: { limit, offset, fields: "id,name,type" },
       },
       { response: ListItemsResponseSchema },
@@ -557,7 +557,7 @@ import { RestApiValidationError } from "@superblocksteam/sdk-api";
 
 try {
   const result = await ctx.integrations.box.apiRequest(
-    { method: "GET", path: `/2.0/folders/${folderId}/items`, params: { ... } },
+    { method: "GET", path: `/folders/${folderId}/items`, params: { ... } },
     { response: ListItemsResponseSchema }
   );
 } catch (error) {

package/src/integrations/box/docs.manifest.json

@@ -0,0 +1,5 @@
+{
+  "pluginId": "box",
+  "base": "README.md",
+  "overlays": []
+}

package/src/integrations/box/types.ts

@@ -24,7 +24,7 @@ import type { SupportsApiRequest } from "../base/index.js";
  * const result = await box.apiRequest(
  *   {
  *     method: 'GET',
- *     path: '/2.0/folders/0',
+ *     path: '/folders/0',
  *   },
  *   { response: ResponseSchema }
  * );