@binalyze/air-sdk 5.4.2 → 5.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -8
- package/dist/domains/interact.js +107 -0
- package/dist/domains/interact.js.map +1 -1
- package/dist/domains/tasks.js +75 -0
- package/dist/domains/tasks.js.map +1 -1
- package/dist/sdk/typescript-axios/sdk.gen.d.ts +53 -1
- package/dist/sdk/typescript-axios/sdk.gen.js +231 -4
- package/dist/sdk/typescript-axios/sdk.gen.js.map +1 -1
- package/dist/sdk/typescript-axios/types.gen.d.ts +458 -56
- package/dist/types/interact.d.ts +26 -0
- package/dist/types/tasks.d.ts +25 -0
- package/package.json +1 -1
package/dist/types/tasks.d.ts
CHANGED
|
@@ -122,4 +122,29 @@ export interface ITasksAPI {
|
|
|
122
122
|
get: (options: IGetTaskOptions) => Promise<Task>;
|
|
123
123
|
getMany: (options?: IGetTasksOptions) => Promise<ITasksPage>;
|
|
124
124
|
getAssignments: (options: IGetTaskAssignmentsOptions) => Promise<ITaskAssignmentsPage>;
|
|
125
|
+
waitForCompletion: (options: IWaitForCompletionOptions) => Promise<IWaitForCompletionResult>;
|
|
126
|
+
}
|
|
127
|
+
export interface IWaitForCompletionOptions {
|
|
128
|
+
taskId: string;
|
|
129
|
+
/**
|
|
130
|
+
* Timeout in seconds. If 0 or undefined, waits indefinitely.
|
|
131
|
+
*/
|
|
132
|
+
timeoutSeconds?: number;
|
|
133
|
+
/**
|
|
134
|
+
* Poll interval in milliseconds. If not provided, defaults to 300000 when waiting indefinitely,
|
|
135
|
+
* otherwise 60000.
|
|
136
|
+
*/
|
|
137
|
+
pollIntervalMs?: number;
|
|
138
|
+
}
|
|
139
|
+
export type WaitForCompletionStatus = 'completed' | 'cancelled' | 'failed' | 'timeout';
|
|
140
|
+
export interface IWaitForCompletionResult {
|
|
141
|
+
taskId: string;
|
|
142
|
+
status: WaitForCompletionStatus;
|
|
143
|
+
message: string;
|
|
144
|
+
taskStatus?: string;
|
|
145
|
+
taskType?: string;
|
|
146
|
+
organizationId?: number;
|
|
147
|
+
createdAt?: string;
|
|
148
|
+
updatedAt?: string;
|
|
149
|
+
error?: string;
|
|
125
150
|
}
|