chore: break long lines in snippets into multiline

Author: stainless-app[bot]

README.md

@@ -68,13 +68,6 @@ The SDK provides object-oriented interfaces for all major Runloop resources:
 
 The SDK is fully typed with comprehensive TypeScript definitions:
 
-```typescript
-import { RunloopSDK, type DevboxView } from '@runloop/api-client';
-
-const runloop = new RunloopSDK();
-const devbox: DevboxView = await runloop.devbox.create();
-```
-
 ### Scorers
 
 Scorers are custom scoring functions used to evaluate scenario outputs. Create scorers via `runloop.scorer.create()`, then update or validate them with the returned `Scorer` instance:
@@ -141,8 +134,60 @@ const snapshot = await devbox.snapshotDisk();
 await snapshot.createDevbox();
 ...
 await devbox.shutdown();
+
 ```
 
+## File write
+
+
+// You can also pass a `fetch` `Response`:
+await client.devboxes.uploadFile('id', {
+  path: 'path',
+  file: await fetch('https://somesite/file'),
+});
+
+// Finally, if none of the above are convenient, you can use our `toFile` helper:
+await client.devboxes.uploadFile('id', {
+  path: 'path',
+  file: await toFile(Buffer.from('my bytes'), 'file'),
+});
+await client.devboxes.uploadFile('id', {
+  path: 'path',
+  file: await toFile(new Uint8Array([0, 1, 2]), 'file'),
+});
+```
+
+## Handling errors
+
+When the library is unable to connect to the API,
+or if the API returns a non-success status code (i.e., 4xx or 5xx response),
+a subclass of `APIError` will be thrown:
+
+<!-- prettier-ignore -->
+```ts
+const devboxView = await client.devboxes.create().catch(async (err) => {
+  if (err instanceof Runloop.APIError) {
+    console.log(err.status); // 400
+    console.log(err.name); // BadRequestError
+    console.log(err.headers); // {server: 'nginx', ...}
+  } else {
+    throw err;
+  }
+});
+```typescript
+import { RunloopSDK, type DevboxView } from '@runloop/api-client';
+
+const runloop = new RunloopSDK();
+const devbox: DevboxView = await runloop.devbox.create();
+```
+
+
+// If you have access to Node `fs` we recommend using `fs.createReadStream()`:
+await client.devboxes.uploadFile('id', {
+  path: 'path',
+  file: fs.createReadStream('/path/to/file'),
+});
+
 ## Advanced Configuration
 
 Customize the SDK with your API token, endpoint, timeout, and retry settings:

tests/api-resources/agents.test.ts

@@ -26,10 +26,22 @@ describe('resource agents', () => {
       version: 'version',
       source: {
         type: 'type',
-        git: { repository: 'repository', agent_setup: ['string'], ref: 'ref' },
-        npm: { package_name: 'package_name', agent_setup: ['string'], registry_url: 'registry_url' },
+        git: {
+          repository: 'repository',
+          agent_setup: ['string'],
+          ref: 'ref',
+        },
+        npm: {
+          package_name: 'package_name',
+          agent_setup: ['string'],
+          registry_url: 'registry_url',
+        },
         object: { object_id: 'object_id', agent_setup: ['string'] },
-        pip: { package_name: 'package_name', agent_setup: ['string'], registry_url: 'registry_url' },
+        pip: {
+          package_name: 'package_name',
+          agent_setup: ['string'],
+          registry_url: 'registry_url',
+        },
       },
     });
   });

tests/api-resources/benchmarks/benchmarks.test.ts

@@ -109,7 +109,11 @@ describe('resource benchmarks', () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(
       client.benchmarks.list(
-        { limit: 0, name: 'name', starting_after: 'starting_after' },
+        {
+          limit: 0,
+          name: 'name',
+          starting_after: 'starting_after',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);
@@ -203,7 +207,13 @@ describe('resource benchmarks', () => {
           resource_size_request: 'X_SMALL',
           user_parameters: { uid: 0, username: 'username' },
         },
-        mounts: [{ object_id: 'object_id', object_path: 'object_path', type: 'object_mount' }],
+        mounts: [
+          {
+            object_id: 'object_id',
+            object_path: 'object_path',
+            type: 'object_mount',
+          },
+        ],
         purpose: 'purpose',
         secrets: { foo: 'string' },
       },

tests/api-resources/benchmarks/runs.test.ts

@@ -49,7 +49,12 @@ describe('resource runs', () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(
       client.benchmarks.runs.list(
-        { benchmark_id: 'benchmark_id', limit: 0, name: 'name', starting_after: 'starting_after' },
+        {
+          benchmark_id: 'benchmark_id',
+          limit: 0,
+          name: 'name',
+          starting_after: 'starting_after',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);
@@ -114,7 +119,11 @@ describe('resource runs', () => {
     await expect(
       client.benchmarks.runs.listScenarioRuns(
         'id',
-        { limit: 0, starting_after: 'starting_after', state: 'running' },
+        {
+          limit: 0,
+          starting_after: 'starting_after',
+          state: 'running',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);

tests/api-resources/blueprints.test.ts

@@ -131,7 +131,12 @@ describe('resource blueprints', () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(
       client.blueprints.list(
-        { limit: 0, name: 'name', starting_after: 'starting_after', status: 'status' },
+        {
+          limit: 0,
+          name: 'name',
+          starting_after: 'starting_after',
+          status: 'status',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);
@@ -215,7 +220,12 @@ describe('resource blueprints', () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(
       client.blueprints.listPublic(
-        { limit: 0, name: 'name', starting_after: 'starting_after', status: 'status' },
+        {
+          limit: 0,
+          name: 'name',
+          starting_after: 'starting_after',
+          status: 'status',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);

tests/api-resources/devboxes/computers.test.ts

@@ -31,7 +31,10 @@ describe('resource computers', () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(
       client.devboxes.computers.create(
-        { display_dimensions: { display_height_px: 0, display_width_px: 0 }, name: 'name' },
+        {
+          display_dimensions: { display_height_px: 0, display_width_px: 0 },
+          name: 'name',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);

tests/api-resources/devboxes/devboxes.test.ts

@@ -60,7 +60,13 @@ describe('resource devboxes', () => {
             user_parameters: { uid: 0, username: 'username' },
           },
           metadata: { foo: 'string' },
-          mounts: [{ object_id: 'object_id', object_path: 'object_path', type: 'object_mount' }],
+          mounts: [
+            {
+              object_id: 'object_id',
+              object_path: 'object_path',
+              type: 'object_mount',
+            },
+          ],
           name: 'name',
           repo_connection_id: 'repo_connection_id',
           secrets: { foo: 'string' },
@@ -112,7 +118,10 @@ describe('resource devboxes', () => {
     await expect(
       client.devboxes.update(
         'id',
-        { metadata: { foo: 'string' }, name: 'name' },
+        {
+          metadata: { foo: 'string' },
+          name: 'name',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);
@@ -140,7 +149,11 @@ describe('resource devboxes', () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(
       client.devboxes.list(
-        { limit: 0, starting_after: 'starting_after', status: 'provisioning' },
+        {
+          limit: 0,
+          starting_after: 'starting_after',
+          status: 'provisioning',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);
@@ -403,7 +416,11 @@ describe('resource devboxes', () => {
     await expect(
       client.devboxes.snapshotDisk(
         'id',
-        { commit_message: 'commit_message', metadata: { foo: 'string' }, name: 'name' },
+        {
+          commit_message: 'commit_message',
+          metadata: { foo: 'string' },
+          name: 'name',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);
@@ -432,7 +449,11 @@ describe('resource devboxes', () => {
     await expect(
       client.devboxes.snapshotDiskAsync(
         'id',
-        { commit_message: 'commit_message', metadata: { foo: 'string' }, name: 'name' },
+        {
+          commit_message: 'commit_message',
+          metadata: { foo: 'string' },
+          name: 'name',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);

tests/api-resources/devboxes/disk-snapshots.test.ts

@@ -32,7 +32,11 @@ describe('resource diskSnapshots', () => {
     await expect(
       client.devboxes.diskSnapshots.update(
         'id',
-        { commit_message: 'commit_message', metadata: { foo: 'string' }, name: 'name' },
+        {
+          commit_message: 'commit_message',
+          metadata: { foo: 'string' },
+          name: 'name',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);

tests/api-resources/repositories.test.ts

@@ -69,7 +69,12 @@ describe('resource repositories', () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(
       client.repositories.list(
-        { limit: 0, name: 'name', owner: 'owner', starting_after: 'starting_after' },
+        {
+          limit: 0,
+          name: 'name',
+          owner: 'owner',
+          starting_after: 'starting_after',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);

tests/api-resources/scenarios/scenarios.test.ts

@@ -17,7 +17,11 @@ describe('resource scenarios', () => {
         scoring_function_parameters: [
           {
             name: 'name',
-            scorer: { pattern: 'pattern', search_directory: 'search_directory', type: 'ast_grep_scorer' },
+            scorer: {
+              pattern: 'pattern',
+              search_directory: 'search_directory',
+              type: 'ast_grep_scorer',
+            },
             weight: 0,
           },
         ],
@@ -34,7 +38,10 @@ describe('resource scenarios', () => {
 
   test('create: required and optional params', async () => {
     const response = await client.scenarios.create({
-      input_context: { problem_statement: 'problem_statement', additional_context: {} },
+      input_context: {
+        problem_statement: 'problem_statement',
+        additional_context: {},
+      },
       name: 'name',
       scoring_contract: {
         scoring_function_parameters: [
@@ -136,7 +143,10 @@ describe('resource scenarios', () => {
             snapshot_id: 'snapshot_id',
             working_directory: 'working_directory',
           },
-          input_context: { additional_context: {}, problem_statement: 'problem_statement' },
+          input_context: {
+            additional_context: {},
+            problem_statement: 'problem_statement',
+          },
           metadata: { foo: 'string' },
           name: 'name',
           reference_output: 'reference_output',
@@ -219,7 +229,11 @@ describe('resource scenarios', () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(
       client.scenarios.listPublic(
-        { limit: 0, name: 'name', starting_after: 'starting_after' },
+        {
+          limit: 0,
+          name: 'name',
+          starting_after: 'starting_after',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Runloop.NotFoundError);
@@ -257,7 +271,13 @@ describe('resource scenarios', () => {
           resource_size_request: 'X_SMALL',
           user_parameters: { uid: 0, username: 'username' },
         },
-        mounts: [{ object_id: 'object_id', object_path: 'object_path', type: 'object_mount' }],
+        mounts: [
+          {
+            object_id: 'object_id',
+            object_path: 'object_path',
+            type: 'object_mount',
+          },
+        ],
         purpose: 'purpose',
         secrets: { foo: 'string' },
       },