chore(types): extract run status to a named type (#686)

openai · Feb 22, 2024 · b3b3b8e · b3b3b8e
1 parent f2704d5
commit b3b3b8e
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 10 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,7 +14,7 @@ jobs:
     if: github.repository == 'openai/openai-node'
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Node
         uses: actions/setup-node@v4

diff --git a/api.md b/api.md
@@ -221,6 +221,7 @@ Types:
 
 - <code><a href="./src/resources/beta/threads/runs/runs.ts">RequiredActionFunctionToolCall</a></code>
 - <code><a href="./src/resources/beta/threads/runs/runs.ts">Run</a></code>
+- <code><a href="./src/resources/beta/threads/runs/runs.ts">RunStatus</a></code>
 
 Methods:
 

diff --git a/src/resources/beta/threads/index.ts b/src/resources/beta/threads/index.ts
@@ -14,6 +14,7 @@ export {
 export {
   RequiredActionFunctionToolCall,
   Run,
+  RunStatus,
   RunCreateParams,
   RunUpdateParams,
   RunListParams,

diff --git a/src/resources/beta/threads/runs/index.ts b/src/resources/beta/threads/runs/index.ts
@@ -14,6 +14,7 @@ export {
 export {
   RequiredActionFunctionToolCall,
   Run,
+  RunStatus,
   RunCreateParams,
   RunUpdateParams,
   RunListParams,

diff --git a/src/resources/beta/threads/runs/runs.ts b/src/resources/beta/threads/runs/runs.ts
@@ -242,15 +242,7 @@ export interface Run {
    * `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or
    * `expired`.
    */
-  status:
-    | 'queued'
-    | 'in_progress'
-    | 'requires_action'
-    | 'cancelling'
-    | 'cancelled'
-    | 'failed'
-    | 'completed'
-    | 'expired';
+  status: RunStatus;
 
   /**
    * The ID of the [thread](https://platform.openai.com/docs/api-reference/threads)
@@ -361,6 +353,21 @@ export namespace Run {
   }
 }
 
+/**
+ * The status of the run, which can be either `queued`, `in_progress`,
+ * `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or
+ * `expired`.
+ */
+export type RunStatus =
+  | 'queued'
+  | 'in_progress'
+  | 'requires_action'
+  | 'cancelling'
+  | 'cancelled'
+  | 'failed'
+  | 'completed'
+  | 'expired';
+
 export interface RunCreateParams {
   /**
    * The ID of the
@@ -486,6 +493,7 @@ export namespace RunSubmitToolOutputsParams {
 export namespace Runs {
   export import RequiredActionFunctionToolCall = RunsAPI.RequiredActionFunctionToolCall;
   export import Run = RunsAPI.Run;
+  export import RunStatus = RunsAPI.RunStatus;
   export import RunsPage = RunsAPI.RunsPage;
   export import RunCreateParams = RunsAPI.RunCreateParams;
   export import RunUpdateParams = RunsAPI.RunUpdateParams;

diff --git a/src/resources/beta/threads/threads.ts b/src/resources/beta/threads/threads.ts
@@ -298,6 +298,7 @@ export namespace Threads {
   export import Runs = RunsAPI.Runs;
   export import RequiredActionFunctionToolCall = RunsAPI.RequiredActionFunctionToolCall;
   export import Run = RunsAPI.Run;
+  export import RunStatus = RunsAPI.RunStatus;
   export import RunsPage = RunsAPI.RunsPage;
   export import RunCreateParams = RunsAPI.RunCreateParams;
   export import RunUpdateParams = RunsAPI.RunUpdateParams;