feat(workflows): add bulk support (#2526)

stainless-app[bot] · stainless-app[bot] · commit 07e881359690 · 2025-03-18T01:55:39.000Z
diff --git a/.stats.yml b/.stats.yml
@@ -1,2 +1,2 @@
-configured_endpoints: 1650
+configured_endpoints: 1651
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-0ed9f898b31619623e50d660d04beca50e44987bfd3eb3a6ff98d3bca2a9c569.yml
diff --git a/api.md b/api.md
@@ -7856,12 +7856,14 @@ Types:
 
 - <code><a href="./src/resources/workflows/instances/instances.ts">InstanceCreateResponse</a></code>
 - <code><a href="./src/resources/workflows/instances/instances.ts">InstanceListResponse</a></code>
+- <code><a href="./src/resources/workflows/instances/instances.ts">InstanceBulkResponse</a></code>
 - <code><a href="./src/resources/workflows/instances/instances.ts">InstanceGetResponse</a></code>
 
 Methods:
 
 - <code title="post /accounts/{account_id}/workflows/{workflow_name}/instances">client.workflows.instances.<a href="./src/resources/workflows/instances/instances.ts">create</a>(workflowName, { ...params }) -> InstanceCreateResponse</code>
 - <code title="get /accounts/{account_id}/workflows/{workflow_name}/instances">client.workflows.instances.<a href="./src/resources/workflows/instances/instances.ts">list</a>(workflowName, { ...params }) -> InstanceListResponsesV4PagePaginationArray</code>
+- <code title="post /accounts/{account_id}/workflows/{workflow_name}/instances/batch">client.workflows.instances.<a href="./src/resources/workflows/instances/instances.ts">bulk</a>(workflowName, [ ...body ]) -> InstanceBulkResponsesSinglePage</code>
 - <code title="get /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}">client.workflows.instances.<a href="./src/resources/workflows/instances/instances.ts">get</a>(workflowName, instanceId, { ...params }) -> InstanceGetResponse</code>
 
 ### Status
diff --git a/src/resources/workflows/index.ts b/src/resources/workflows/index.ts
@@ -2,12 +2,15 @@
 
 export {
   InstanceListResponsesV4PagePaginationArray,
+  InstanceBulkResponsesSinglePage,
   Instances,
   type InstanceCreateResponse,
   type InstanceListResponse,
+  type InstanceBulkResponse,
   type InstanceGetResponse,
   type InstanceCreateParams,
   type InstanceListParams,
+  type InstanceBulkParams,
   type InstanceGetParams,
 } from './instances/index';
 export {
diff --git a/src/resources/workflows/instances/index.ts b/src/resources/workflows/instances/index.ts
@@ -2,12 +2,15 @@
 
 export {
   InstanceListResponsesV4PagePaginationArray,
+  InstanceBulkResponsesSinglePage,
   Instances,
   type InstanceCreateResponse,
   type InstanceListResponse,
+  type InstanceBulkResponse,
   type InstanceGetResponse,
   type InstanceCreateParams,
   type InstanceListParams,
+  type InstanceBulkParams,
   type InstanceGetParams,
 } from './instances';
 export { Status, type StatusEditResponse, type StatusEditParams } from './status';
diff --git a/src/resources/workflows/instances/instances.ts b/src/resources/workflows/instances/instances.ts
@@ -4,7 +4,7 @@ import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
 import * as StatusAPI from './status';
 import { Status, StatusEditParams, StatusEditResponse } from './status';
-import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../pagination';
+import { SinglePage, V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../pagination';
 
 export class Instances extends APIResource {
   status: StatusAPI.Status = new StatusAPI.Status(this._client);
@@ -42,6 +42,22 @@ export class Instances extends APIResource {
     );
   }
 
+  /**
+   * Batch create new Workflow instances
+   */
+  bulk(
+    workflowName: string,
+    params: InstanceBulkParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InstanceBulkResponsesSinglePage, InstanceBulkResponse> {
+    const { account_id, body } = params ?? {};
+    return this._client.getAPIList(
+      `/accounts/${account_id}/workflows/${workflowName}/instances/batch`,
+      InstanceBulkResponsesSinglePage,
+      { body: body, method: 'post', ...options },
+    );
+  }
+
   /**
    * Get logs and status from instance
    */
@@ -63,6 +79,8 @@ export class Instances extends APIResource {
 
 export class InstanceListResponsesV4PagePaginationArray extends V4PagePaginationArray<InstanceListResponse> {}
 
+export class InstanceBulkResponsesSinglePage extends SinglePage<InstanceBulkResponse> {}
+
 export interface InstanceCreateResponse {
   id: string;
 
@@ -109,6 +127,25 @@ export interface InstanceListResponse {
   workflow_id: string;
 }
 
+export interface InstanceBulkResponse {
+  id: string;
+
+  status:
+    | 'queued'
+    | 'running'
+    | 'paused'
+    | 'errored'
+    | 'terminated'
+    | 'complete'
+    | 'waitingForPause'
+    | 'waiting'
+    | 'unknown';
+
+  version_id: string;
+
+  workflow_id: string;
+}
+
 export interface InstanceGetResponse {
   end: string | null;
 
@@ -292,21 +329,45 @@ export interface InstanceListParams extends V4PagePaginationArrayParams {
     | 'unknown';
 }
 
+export interface InstanceBulkParams {
+  /**
+   * Path param:
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  body?: Array<InstanceBulkParams.Body>;
+}
+
+export namespace InstanceBulkParams {
+  export interface Body {
+    instance_id?: string;
+
+    params?: unknown;
+  }
+}
+
 export interface InstanceGetParams {
   account_id: string;
 }
 
 Instances.InstanceListResponsesV4PagePaginationArray = InstanceListResponsesV4PagePaginationArray;
+Instances.InstanceBulkResponsesSinglePage = InstanceBulkResponsesSinglePage;
 Instances.Status = Status;
 
 export declare namespace Instances {
   export {
     type InstanceCreateResponse as InstanceCreateResponse,
     type InstanceListResponse as InstanceListResponse,
+    type InstanceBulkResponse as InstanceBulkResponse,
     type InstanceGetResponse as InstanceGetResponse,
     InstanceListResponsesV4PagePaginationArray as InstanceListResponsesV4PagePaginationArray,
+    InstanceBulkResponsesSinglePage as InstanceBulkResponsesSinglePage,
     type InstanceCreateParams as InstanceCreateParams,
     type InstanceListParams as InstanceListParams,
+    type InstanceBulkParams as InstanceBulkParams,
     type InstanceGetParams as InstanceGetParams,
   };
 
diff --git a/src/resources/workflows/workflows.ts b/src/resources/workflows/workflows.ts
@@ -13,6 +13,9 @@ import {
 } from './versions';
 import * as InstancesAPI from './instances/instances';
 import {
+  InstanceBulkParams,
+  InstanceBulkResponse,
+  InstanceBulkResponsesSinglePage,
   InstanceCreateParams,
   InstanceCreateResponse,
   InstanceGetParams,
@@ -207,6 +210,7 @@ export interface WorkflowGetParams {
 
 Workflows.Instances = InstancesAPIInstances;
 Workflows.InstanceListResponsesV4PagePaginationArray = InstanceListResponsesV4PagePaginationArray;
+Workflows.InstanceBulkResponsesSinglePage = InstanceBulkResponsesSinglePage;
 Workflows.Versions = Versions;
 Workflows.VersionListResponsesV4PagePaginationArray = VersionListResponsesV4PagePaginationArray;
 
@@ -215,10 +219,13 @@ export declare namespace Workflows {
     InstancesAPIInstances as Instances,
     type InstanceCreateResponse as InstanceCreateResponse,
     type InstanceListResponse as InstanceListResponse,
+    type InstanceBulkResponse as InstanceBulkResponse,
     type InstanceGetResponse as InstanceGetResponse,
     InstanceListResponsesV4PagePaginationArray as InstanceListResponsesV4PagePaginationArray,
+    InstanceBulkResponsesSinglePage as InstanceBulkResponsesSinglePage,
     type InstanceCreateParams as InstanceCreateParams,
     type InstanceListParams as InstanceListParams,
+    type InstanceBulkParams as InstanceBulkParams,
     type InstanceGetParams as InstanceGetParams,
   };
 
diff --git a/tests/api-resources/workflows/instances/instances.test.ts b/tests/api-resources/workflows/instances/instances.test.ts
@@ -51,6 +51,24 @@ describe('resource instances', () => {
     });
   });
 
+  test('bulk: only required params', async () => {
+    const responsePromise = client.workflows.instances.bulk('x', { account_id: 'account_id' });
+    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);
+  });
+
+  test('bulk: required and optional params', async () => {
+    const response = await client.workflows.instances.bulk('x', {
+      account_id: 'account_id',
+      body: [{ instance_id: 'instance_id', params: {} }],
+    });
+  });
+
   test('get: only required params', async () => {
     const responsePromise = client.workflows.instances.get('x', 'x', { account_id: 'account_id' });
     const rawResponse = await responsePromise.asResponse();

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-configured_endpoints: 1650`
	`1`	`+configured_endpoints: 1651`
`2`	`2`	`openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-0ed9f898b31619623e50d660d04beca50e44987bfd3eb3a6ff98d3bca2a9c569.yml`