Skip to content

Commit 90a733e

Browse files
committed
chore(types): extract run status to a named type (#686)
1 parent 684f139 commit 90a733e

File tree

6 files changed

+22
-10
lines changed

6 files changed

+22
-10
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
if: github.repository == 'openai/openai-node'
1515

1616
steps:
17-
- uses: actions/checkout@v3
17+
- uses: actions/checkout@v4
1818

1919
- name: Set up Node
2020
uses: actions/setup-node@v4

api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,7 @@ Types:
221221

222222
- <code><a href="./src/resources/beta/threads/runs/runs.ts">RequiredActionFunctionToolCall</a></code>
223223
- <code><a href="./src/resources/beta/threads/runs/runs.ts">Run</a></code>
224+
- <code><a href="./src/resources/beta/threads/runs/runs.ts">RunStatus</a></code>
224225

225226
Methods:
226227

src/resources/beta/threads/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ export {
1414
export {
1515
RequiredActionFunctionToolCall,
1616
Run,
17+
RunStatus,
1718
RunCreateParams,
1819
RunUpdateParams,
1920
RunListParams,

src/resources/beta/threads/runs/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ export {
1414
export {
1515
RequiredActionFunctionToolCall,
1616
Run,
17+
RunStatus,
1718
RunCreateParams,
1819
RunUpdateParams,
1920
RunListParams,

src/resources/beta/threads/runs/runs.ts

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -242,15 +242,7 @@ export interface Run {
242242
* `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or
243243
* `expired`.
244244
*/
245-
status:
246-
| 'queued'
247-
| 'in_progress'
248-
| 'requires_action'
249-
| 'cancelling'
250-
| 'cancelled'
251-
| 'failed'
252-
| 'completed'
253-
| 'expired';
245+
status: RunStatus;
254246

255247
/**
256248
* The ID of the [thread](https://platform.openai.com/docs/api-reference/threads)
@@ -361,6 +353,21 @@ export namespace Run {
361353
}
362354
}
363355

356+
/**
357+
* The status of the run, which can be either `queued`, `in_progress`,
358+
* `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or
359+
* `expired`.
360+
*/
361+
export type RunStatus =
362+
| 'queued'
363+
| 'in_progress'
364+
| 'requires_action'
365+
| 'cancelling'
366+
| 'cancelled'
367+
| 'failed'
368+
| 'completed'
369+
| 'expired';
370+
364371
export interface RunCreateParams {
365372
/**
366373
* The ID of the
@@ -486,6 +493,7 @@ export namespace RunSubmitToolOutputsParams {
486493
export namespace Runs {
487494
export import RequiredActionFunctionToolCall = RunsAPI.RequiredActionFunctionToolCall;
488495
export import Run = RunsAPI.Run;
496+
export import RunStatus = RunsAPI.RunStatus;
489497
export import RunsPage = RunsAPI.RunsPage;
490498
export import RunCreateParams = RunsAPI.RunCreateParams;
491499
export import RunUpdateParams = RunsAPI.RunUpdateParams;

src/resources/beta/threads/threads.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,7 @@ export namespace Threads {
298298
export import Runs = RunsAPI.Runs;
299299
export import RequiredActionFunctionToolCall = RunsAPI.RequiredActionFunctionToolCall;
300300
export import Run = RunsAPI.Run;
301+
export import RunStatus = RunsAPI.RunStatus;
301302
export import RunsPage = RunsAPI.RunsPage;
302303
export import RunCreateParams = RunsAPI.RunCreateParams;
303304
export import RunUpdateParams = RunsAPI.RunUpdateParams;

0 commit comments

Comments
 (0)