feat(api): update via SDK Studio

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 10
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-3edc7a0eef4a0d4495782efbdb0d9b777a55aee058dab119f90de56019441326.yml
-openapi_spec_hash: dff0b1efa1c1614cf770ed8327cefab2
-config_hash: cb04a4d88ee9f530b303ca57ff7090b3
+configured_endpoints: 11
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-64ccdff4ca5d73d79d89e817fe83ccfd3d529696df3e6818c3c75e586ae00801.yml
+openapi_spec_hash: 21c7b8757fc0cc9415cda1bc06251de6
+config_hash: b3fcacd707da56b21d31ce0baf4fb87d

api.md

@@ -26,11 +26,13 @@ Types:
 
 - <code><a href="./src/resources/apps/invocations.ts">InvocationCreateResponse</a></code>
 - <code><a href="./src/resources/apps/invocations.ts">InvocationRetrieveResponse</a></code>
+- <code><a href="./src/resources/apps/invocations.ts">InvocationUpdateResponse</a></code>
 
 Methods:
 
 - <code title="post /invocations">client.apps.invocations.<a href="./src/resources/apps/invocations.ts">create</a>({ ...params }) -> InvocationCreateResponse</code>
 - <code title="get /invocations/{id}">client.apps.invocations.<a href="./src/resources/apps/invocations.ts">retrieve</a>(id) -> InvocationRetrieveResponse</code>
+- <code title="patch /invocations/{id}">client.apps.invocations.<a href="./src/resources/apps/invocations.ts">update</a>(id, { ...params }) -> InvocationUpdateResponse</code>
 
 # Browsers
 

src/resources/apps/apps.ts

@@ -13,6 +13,8 @@ import {
   InvocationCreateParams,
   InvocationCreateResponse,
   InvocationRetrieveResponse,
+  InvocationUpdateParams,
+  InvocationUpdateResponse,
   Invocations,
 } from './invocations';
 import { APIPromise } from '../../core/api-promise';
@@ -99,6 +101,8 @@ export declare namespace Apps {
     Invocations as Invocations,
     type InvocationCreateResponse as InvocationCreateResponse,
     type InvocationRetrieveResponse as InvocationRetrieveResponse,
+    type InvocationUpdateResponse as InvocationUpdateResponse,
     type InvocationCreateParams as InvocationCreateParams,
+    type InvocationUpdateParams as InvocationUpdateParams,
   };
 }

src/resources/apps/index.ts

@@ -11,5 +11,7 @@ export {
   Invocations,
   type InvocationCreateResponse,
   type InvocationRetrieveResponse,
+  type InvocationUpdateResponse,
   type InvocationCreateParams,
+  type InvocationUpdateParams,
 } from './invocations';

src/resources/apps/invocations.ts

@@ -35,6 +35,25 @@ export class Invocations extends APIResource {
   retrieve(id: string, options?: RequestOptions): APIPromise<InvocationRetrieveResponse> {
     return this._client.get(path`/invocations/${id}`, options);
   }
+
+  /**
+   * Update invocation status or output
+   *
+   * @example
+   * ```ts
+   * const invocation = await client.apps.invocations.update(
+   *   'id',
+   *   { status: 'succeeded' },
+   * );
+   * ```
+   */
+  update(
+    id: string,
+    body: InvocationUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<InvocationUpdateResponse> {
+    return this._client.patch(path`/invocations/${id}`, { body, ...options });
+  }
 }
 
 export interface InvocationCreateResponse {
@@ -109,6 +128,55 @@ export interface InvocationRetrieveResponse {
   status_reason?: string;
 }
 
+export interface InvocationUpdateResponse {
+  /**
+   * ID of the invocation
+   */
+  id: string;
+
+  /**
+   * Name of the action invoked
+   */
+  action_name: string;
+
+  /**
+   * Name of the application
+   */
+  app_name: string;
+
+  /**
+   * RFC 3339 Nanoseconds timestamp when the invocation started
+   */
+  started_at: string;
+
+  /**
+   * Status of the invocation
+   */
+  status: 'queued' | 'running' | 'succeeded' | 'failed';
+
+  /**
+   * RFC 3339 Nanoseconds timestamp when the invocation finished (null if still
+   * running)
+   */
+  finished_at?: string | null;
+
+  /**
+   * Output produced by the action, rendered as a JSON string. This could be: string,
+   * number, boolean, array, object, or null.
+   */
+  output?: string;
+
+  /**
+   * Payload provided to the invocation. This is a string that can be parsed as JSON.
+   */
+  payload?: string;
+
+  /**
+   * Status reason
+   */
+  status_reason?: string;
+}
+
 export interface InvocationCreateParams {
   /**
    * Name of the action to invoke
@@ -125,16 +193,36 @@ export interface InvocationCreateParams {
    */
   version: string;
 
+  /**
+   * If true, invoke asynchronously. When set, the API responds 202 Accepted with
+   * status "queued".
+   */
+  async?: boolean;
+
   /**
    * Input data for the action, sent as a JSON string.
    */
   payload?: string;
 }
 
+export interface InvocationUpdateParams {
+  /**
+   * New status for the invocation.
+   */
+  status: 'succeeded' | 'failed';
+
+  /**
+   * Updated output of the invocation rendered as JSON string.
+   */
+  output?: string;
+}
+
 export declare namespace Invocations {
   export {
     type InvocationCreateResponse as InvocationCreateResponse,
     type InvocationRetrieveResponse as InvocationRetrieveResponse,
+    type InvocationUpdateResponse as InvocationUpdateResponse,
     type InvocationCreateParams as InvocationCreateParams,
+    type InvocationUpdateParams as InvocationUpdateParams,
   };
 }

tests/api-resources/apps/invocations.test.ts

@@ -30,6 +30,7 @@ describe('resource invocations', () => {
       action_name: 'analyze',
       app_name: 'my-app',
       version: '1.0.0',
+      async: true,
       payload: '{"data":"example input"}',
     });
   });
@@ -45,4 +46,21 @@ describe('resource invocations', () => {
     expect(dataAndResponse.data).toBe(response);
     expect(dataAndResponse.response).toBe(rawResponse);
   });
+
+  // skipped: tests are disabled for the time being
+  test.skip('update: only required params', async () => {
+    const responsePromise = client.apps.invocations.update('id', { status: 'succeeded' });
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  // skipped: tests are disabled for the time being
+  test.skip('update: required and optional params', async () => {
+    const response = await client.apps.invocations.update('id', { status: 'succeeded', output: 'output' });
+  });
 });