feat(api): manual updates (#17)

Author: stainless-app[bot]

README.md

@@ -30,7 +30,7 @@ const client = new Stainless({
 });
 
 async function main() {
-  const output = await client.builds.outputs.retrieve('node', { id: 'bui_123' });
+  const output = await client.builds.outputs.retrieve({ id: 'bui_123', target: 'node' });
 
   console.log(output.commit);
 }
@@ -51,11 +51,8 @@ const client = new Stainless({
 });
 
 async function main() {
-  const params: Stainless.Builds.OutputRetrieveParams = { id: 'bui_123' };
-  const output: Stainless.Builds.OutputRetrieveResponse = await client.builds.outputs.retrieve(
-    'node',
-    params,
-  );
+  const params: Stainless.Builds.OutputRetrieveParams = { id: 'bui_123', target: 'node' };
+  const output: Stainless.Builds.OutputRetrieveResponse = await client.builds.outputs.retrieve(params);
 }
 
 main();
@@ -72,15 +69,17 @@ a subclass of `APIError` will be thrown:
 <!-- prettier-ignore -->
 ```ts
 async function main() {
-  const output = await client.builds.outputs.retrieve('node', { id: 'bui_123' }).catch(async (err) => {
-    if (err instanceof Stainless.APIError) {
-      console.log(err.status); // 400
-      console.log(err.name); // BadRequestError
-      console.log(err.headers); // {server: 'nginx', ...}
-    } else {
-      throw err;
-    }
-  });
+  const output = await client.builds.outputs
+    .retrieve({ id: 'bui_123', target: 'node' })
+    .catch(async (err) => {
+      if (err instanceof Stainless.APIError) {
+        console.log(err.status); // 400
+        console.log(err.name); // BadRequestError
+        console.log(err.headers); // {server: 'nginx', ...}
+      } else {
+        throw err;
+      }
+    });
 }
 
 main();
@@ -115,7 +114,7 @@ const client = new Stainless({
 });
 
 // Or, configure per-request:
-await client.builds.outputs.retrieve('node', { id: 'bui_123' }, {
+await client.builds.outputs.retrieve({ id: 'bui_123', target: 'node' }, {
   maxRetries: 5,
 });
 ```
@@ -132,7 +131,7 @@ const client = new Stainless({
 });
 
 // Override per-request:
-await client.builds.outputs.retrieve('node', { id: 'bui_123' }, {
+await client.builds.outputs.retrieve({ id: 'bui_123', target: 'node' }, {
   timeout: 5 * 1000,
 });
 ```
@@ -153,12 +152,12 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
 ```ts
 const client = new Stainless();
 
-const response = await client.builds.outputs.retrieve('node', { id: 'bui_123' }).asResponse();
+const response = await client.builds.outputs.retrieve({ id: 'bui_123', target: 'node' }).asResponse();
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
 const { data: output, response: raw } = await client.builds.outputs
-  .retrieve('node', { id: 'bui_123' })
+  .retrieve({ id: 'bui_123', target: 'node' })
   .withResponse();
 console.log(raw.headers.get('X-My-Header'));
 console.log(output.commit);
@@ -268,8 +267,7 @@ const client = new Stainless({
 
 // Override per-request:
 await client.builds.outputs.retrieve(
-  'node',
-  { id: 'bui_123' },
+  { id: 'bui_123', target: 'node' },
   {
     httpAgent: new http.Agent({ keepAlive: false }),
   },

api.md

@@ -24,4 +24,4 @@ Types:
 
 Methods:
 
-- <code title="get /v1/builds/{id}/outputs/{target}">client.builds.outputs.<a href="./src/resources/builds/outputs.ts">retrieve</a>(target, { ...params }) -> OutputRetrieveResponse</code>
+- <code title="get /v1/builds/{id}/outputs/{target}">client.builds.outputs.<a href="./src/resources/builds/outputs.ts">retrieve</a>({ ...params }) -> OutputRetrieveResponse</code>

src/resources/builds/outputs.ts

@@ -8,12 +8,8 @@ export class Outputs extends APIResource {
   /**
    * Get the output status and details for a specific target for a specific build
    */
-  retrieve(
-    target: 'node' | 'python' | 'go' | 'java' | 'kotlin' | 'ruby',
-    params: OutputRetrieveParams,
-    options?: RequestOptions,
-  ): APIPromise<OutputRetrieveResponse> {
-    const { id } = params;
+  retrieve(params: OutputRetrieveParams, options?: RequestOptions): APIPromise<OutputRetrieveResponse> {
+    const { id, target } = params;
     return this._client.get(`/v1/builds/${id}/outputs/${target}`, options);
   }
 }
@@ -126,6 +122,11 @@ export interface OutputRetrieveParams {
    * The build ID
    */
   id: string;
+
+  /**
+   * The target to get the output for
+   */
+  target: 'node' | 'python' | 'go' | 'java' | 'kotlin' | 'ruby';
 }
 
 export declare namespace Outputs {

tests/api-resources/builds/outputs.test.ts

@@ -9,7 +9,7 @@ const client = new Stainless({
 
 describe('resource outputs', () => {
   test('retrieve: only required params', async () => {
-    const responsePromise = client.builds.outputs.retrieve('node', { id: 'id' });
+    const responsePromise = client.builds.outputs.retrieve({ id: 'id', target: 'node' });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -20,6 +20,6 @@ describe('resource outputs', () => {
   });
 
   test('retrieve: required and optional params', async () => {
-    const response = await client.builds.outputs.retrieve('node', { id: 'id' });
+    const response = await client.builds.outputs.retrieve({ id: 'id', target: 'node' });
   });
 });