@aviaryhq/cloudglue-js 0.5.9 → 0.6.0

package/dist/src/api/response.api.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnhancedResponseApi = void 0;
+const error_1 = require("../error");
+class EnhancedResponseApi {
+    constructor(api) {
+        this.api = api;
+    }
+    /**
+     * Create a new response using the Response API.
+     * This provides an OpenAI Responses-compatible interface for chat completions with video collections.
+     *
+     * @param params - Response creation parameters
+     * @returns The created response
+     */
+    async createResponse(params) {
+        return this.api.createResponse(params);
+    }
+    /**
+     * List all responses with pagination and filtering options.
+     *
+     * @param params - Optional pagination and filtering parameters
+     * @returns Paginated list of responses
+     */
+    async listResponses(params = {}) {
+        return this.api.listResponses({ queries: params });
+    }
+    /**
+     * Retrieve a specific response by its ID.
+     *
+     * @param responseId - The ID of the response to retrieve
+     * @returns The response object
+     */
+    async getResponse(responseId) {
+        return this.api.getResponse({ params: { id: responseId } });
+    }
+    /**
+     * Delete a response by ID.
+     * This operation is idempotent - deleting a non-existent response returns success.
+     *
+     * @param responseId - The ID of the response to delete
+     * @returns Deletion confirmation
+     */
+    async deleteResponse(responseId) {
+        return this.api.deleteResponse(undefined, { params: { id: responseId } });
+    }
+    /**
+     * Cancel a background response that is in progress.
+     * If the response is already completed, failed, or cancelled, this returns the response as-is.
+     *
+     * @param responseId - The ID of the response to cancel
+     * @returns The response object
+     */
+    async cancelResponse(responseId) {
+        return this.api.cancelResponse(undefined, { params: { id: responseId } });
+    }
+    /**
+     * Waits for a background response to complete by polling until it reaches
+     * a terminal state (completed, failed, or cancelled) or until maxAttempts is reached.
+     *
+     * @param responseId - The ID of the response to wait for
+     * @param options - Optional configuration for polling behavior
+     * @returns The final response object
+     * @throws {CloudGlueError} If the response fails or maxAttempts is reached
+     */
+    async waitForReady(responseId, options = {}) {
+        const { pollingInterval = 5000, maxAttempts = 36 } = options;
+        let attempts = 0;
+        while (attempts < maxAttempts) {
+            const response = await this.getResponse(responseId);
+            // If we've reached a terminal state, return the response
+            if (['completed', 'failed', 'cancelled'].includes(response.status)) {
+                if (response.status === 'failed') {
+                    throw new error_1.CloudGlueError(`Response generation failed: ${response.error?.message || responseId}`);
+                }
+                return response;
+            }
+            // Wait for the polling interval before trying again
+            await new Promise((resolve) => setTimeout(resolve, pollingInterval));
+            attempts++;
+        }
+        throw new error_1.CloudGlueError(`Timeout waiting for response ${responseId} to complete after ${maxAttempts} attempts`);
+    }
+}
+exports.EnhancedResponseApi = EnhancedResponseApi;