samsar-js 0.48.34 → 0.48.36

package/dist/index.d.ts

@@ -30,6 +30,98 @@ export interface SamsarResult<T> {
     creditsRemaining?: number;
     raw: Response;
 }
+export interface SamsarApiKeyValidationResponse {
+    valid: boolean;
+    authType?: string;
+    email?: string | null;
+    username?: string | null;
+    displayName?: string | null;
+    remainingCredits?: number;
+    message?: string;
+    [key: string]: unknown;
+}
+export interface DeploymentProviderCredentials {
+    samsarApiKey?: string;
+    samsar_api_key?: string;
+    openaiApiKey?: string;
+    openai_api_key?: string;
+    falApiKey?: string;
+    fal_api_key?: string;
+    runwayApiKey?: string;
+    runway_api_key?: string;
+    googleCredentialsJson?: string;
+    google_credentials_json?: string;
+    googleCredentialsJsonB64?: string;
+    google_credentials_json_b64?: string;
+    googleProjectId?: string;
+    google_project_id?: string;
+    validateFalRemotely?: boolean;
+    validate_fal_remotely?: boolean;
+    [key: string]: unknown;
+}
+export interface DeploymentProviderValidationResponse {
+    providers: Record<string, {
+        provider?: string;
+        status?: string;
+        ok?: boolean;
+        message?: string;
+        remainingCredits?: number;
+        email?: string | null;
+        [key: string]: unknown;
+    }>;
+    available: {
+        providers: string[];
+        models: string[];
+        actions: string[];
+    };
+    [key: string]: unknown;
+}
+export interface DeploymentProviderCapabilitiesResponse {
+    providers: Record<string, {
+        label?: string;
+        models?: string[];
+        actions?: string[];
+        [key: string]: unknown;
+    }>;
+    [key: string]: unknown;
+}
+export interface ExternalChatCompletionRequest {
+    model?: InferenceModel;
+    messages: Array<Record<string, unknown>>;
+    stream?: false;
+    temperature?: number;
+    top_p?: number;
+    max_tokens?: number;
+    response_format?: Record<string, unknown>;
+    provider_options?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+export interface ExternalChatCompletionResponse {
+    id?: string;
+    object?: string;
+    created?: number;
+    model?: string;
+    choices?: Array<Record<string, unknown>>;
+    usage?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+export interface ExternalMediaRequest {
+    input?: Record<string, unknown>;
+    webhookUrl?: string;
+    webhook_url?: string;
+    [key: string]: unknown;
+}
+export interface ExternalMediaResponse {
+    request_id?: string;
+    session_id?: string;
+    sessionID?: string;
+    status?: string;
+    message?: string;
+    status_endpoint?: string;
+    creditsCharged?: number;
+    remainingCredits?: number | null;
+    [key: string]: unknown;
+}
 export interface FontOptions {
     key?: string;
     font_key?: string;
@@ -2544,6 +2636,127 @@ export declare class SamsarClient {
     getImageStatus(requestId: string, options?: SamsarRequestOptions & {
         queryParams?: QueryParams;
     }): Promise<SamsarResult<GlobalStatusResponse>>;
+    /**
+     * Validate the configured Samsar API key, or a supplied key, against /external/api_key/validate.
+     */
+    validateSamsarApiKey(apiKey?: string, options?: SamsarRequestOptions): Promise<SamsarResult<SamsarApiKeyValidationResponse>>;
+    /**
+     * Validate the configured Samsar API key, or a supplied key, against /v2/external/api_key/validate.
+     */
+    validateV2ExternalSamsarApiKey(apiKey?: string, options?: SamsarRequestOptions): Promise<SamsarResult<SamsarApiKeyValidationResponse>>;
+    /**
+     * Fetch provider/model/action capabilities used by the deployment onboarding flow.
+     */
+    getExternalProviderCapabilities(options?: SamsarRequestOptions): Promise<SamsarResult<DeploymentProviderCapabilitiesResponse>>;
+    /**
+     * Fetch provider/model/action capabilities from /v2/external/providers/capabilities.
+     */
+    getV2ExternalProviderCapabilities(options?: SamsarRequestOptions): Promise<SamsarResult<DeploymentProviderCapabilitiesResponse>>;
+    /**
+     * Validate onboarding provider credentials without storing secrets in the SDK.
+     */
+    validateDeploymentProviders(payload: DeploymentProviderCredentials, options?: SamsarRequestOptions): Promise<SamsarResult<DeploymentProviderValidationResponse>>;
+    /**
+     * Validate onboarding provider credentials through /v2/external/providers/validate.
+     */
+    validateV2ExternalDeploymentProviders(payload: DeploymentProviderCredentials, options?: SamsarRequestOptions): Promise<SamsarResult<DeploymentProviderValidationResponse>>;
+    /**
+     * OpenAI-compatible external chat request billed through Samsar credits.
+     * This calls POST /external/chat.
+     */
+    createExternalChat(payload: ExternalChatCompletionRequest, options?: SamsarRequestOptions): Promise<SamsarResult<ExternalChatCompletionResponse>>;
+    /**
+     * OpenAI-compatible external chat request billed through Samsar credits.
+     * This calls POST /v2/external/chat.
+     */
+    createV2ExternalChat(payload: ExternalChatCompletionRequest, options?: SamsarRequestOptions): Promise<SamsarResult<ExternalChatCompletionResponse>>;
+    /**
+     * OpenAI-compatible external chat completion billed through Samsar credits.
+     */
+    createExternalChatCompletion(payload: ExternalChatCompletionRequest, options?: SamsarRequestOptions): Promise<SamsarResult<ExternalChatCompletionResponse>>;
+    /**
+     * OpenAI-compatible external chat completion billed through Samsar credits.
+     * This calls POST /v2/external/chat/completions.
+     */
+    createV2ExternalChatCompletion(payload: ExternalChatCompletionRequest, options?: SamsarRequestOptions): Promise<SamsarResult<ExternalChatCompletionResponse>>;
+    /**
+     * Low-level wrapper for POST /v2/external/image/{path}. The external image surface mirrors
+     * the existing image API paths, for example assign_title, enhance, remove_branding,
+     * add_image_set, create_rollup_banner, and receipt_templates/query.
+     */
+    requestExternalImage<T = ExternalMediaResponse>(path: string, payload?: ExternalMediaRequest, options?: SamsarRequestOptions): Promise<SamsarResult<T>>;
+    /**
+     * Low-level wrapper for POST /v2/external/image/{path}.
+     */
+    requestV2ExternalImage<T = ExternalMediaResponse>(path: string, payload?: ExternalMediaRequest, options?: SamsarRequestOptions): Promise<SamsarResult<T>>;
+    /**
+     * Retrieve status for an async /external/image request.
+     */
+    getExternalImageStatus(requestId: string, options?: SamsarRequestOptions & {
+        queryParams?: QueryParams;
+    }): Promise<SamsarResult<GlobalStatusResponse>>;
+    /**
+     * Retrieve status for an async /v2/external/image request.
+     */
+    getV2ExternalImageStatus(requestId: string, options?: SamsarRequestOptions & {
+        queryParams?: QueryParams;
+    }): Promise<SamsarResult<GlobalStatusResponse>>;
+    /**
+     * Low-level wrapper for POST /v2/external/video/{path}. The external video surface mirrors
+     * the existing video API paths, including text_to_video, image_list_to_video,
+     * upload_image_data, update_outro_image, translate_video, join_videos, and clone.
+     */
+    requestExternalVideo<T = ExternalMediaResponse>(path: string, payload?: ExternalMediaRequest, options?: SamsarRequestOptions): Promise<SamsarResult<T>>;
+    /**
+     * Low-level wrapper for POST /v2/external/video/{path}.
+     */
+    requestV2ExternalVideo<T = ExternalMediaResponse>(path: string, payload?: ExternalMediaRequest, options?: SamsarRequestOptions): Promise<SamsarResult<T>>;
+    /**
+     * Create a central /v2/external/video text-to-video request using the same input shape as createVideoFromText.
+     */
+    createExternalVideoRequestFromText(input: CreateVideoFromTextInput, options?: {
+        webhookUrl?: string;
+    } & SamsarRequestOptions): Promise<SamsarResult<ExternalMediaResponse>>;
+    /**
+     * Create a central /v2/external/video text-to-video request using the same input shape as createVideoFromText.
+     */
+    createV2ExternalVideoRequestFromText(input: CreateVideoFromTextInput, options?: {
+        webhookUrl?: string;
+    } & SamsarRequestOptions): Promise<SamsarResult<ExternalMediaResponse>>;
+    /**
+     * Create a central /v2/external/video image-list-to-video request using the same input shape as createVideoFromImageList.
+     */
+    createExternalVideoRequestFromImageList(input: CreateVideoFromImageListInput, options?: {
+        webhookUrl?: string;
+    } & SamsarRequestOptions): Promise<SamsarResult<ExternalMediaResponse>>;
+    /**
+     * Create a central /v2/external/video image-list-to-video request using the same input shape as createVideoFromImageList.
+     */
+    createV2ExternalVideoRequestFromImageList(input: CreateVideoFromImageListInput, options?: {
+        webhookUrl?: string;
+    } & SamsarRequestOptions): Promise<SamsarResult<ExternalMediaResponse>>;
+    /**
+     * Retrieve status for an async /external/video request.
+     */
+    getExternalVideoStatus(requestId: string, options?: SamsarRequestOptions & {
+        queryParams?: QueryParams;
+    }): Promise<SamsarResult<GlobalStatusResponse>>;
+    /**
+     * Retrieve status for an async /v2/external/video request.
+     */
+    getV2ExternalVideoStatus(requestId: string, options?: SamsarRequestOptions & {
+        queryParams?: QueryParams;
+    }): Promise<SamsarResult<GlobalStatusResponse>>;
+    /**
+     * Reserved wrapper for POST /v2/external/audio. The processor currently returns 501 until
+     * the external audio request schema is enabled.
+     */
+    requestExternalAudio<T = ExternalMediaResponse>(payload?: ExternalMediaRequest, options?: SamsarRequestOptions): Promise<SamsarResult<T>>;
+    /**
+     * Reserved wrapper for POST /v2/external/audio. The processor currently returns 501 until
+     * the external audio request schema is enabled.
+     */
+    requestV2ExternalAudio<T = ExternalMediaResponse>(payload?: ExternalMediaRequest, options?: SamsarRequestOptions): Promise<SamsarResult<T>>;
     private get;
     private post;
     private postForm;

package/dist/index.js

@@ -2221,6 +2221,179 @@ export class SamsarClient {
     async getImageStatus(requestId, options) {
         return this.getStatus(requestId, { ...options, path: 'image/status' });
     }
+    /**
+     * Validate the configured Samsar API key, or a supplied key, against /external/api_key/validate.
+     */
+    async validateSamsarApiKey(apiKey, options) {
+        return this.validateV2ExternalSamsarApiKey(apiKey, options);
+    }
+    /**
+     * Validate the configured Samsar API key, or a supplied key, against /v2/external/api_key/validate.
+     */
+    async validateV2ExternalSamsarApiKey(apiKey, options) {
+        const headers = apiKey
+            ? { ...(options?.headers ?? {}), Authorization: `Bearer ${apiKey}` }
+            : options?.headers;
+        return this.get(this.buildV2Url('external/api_key/validate'), {
+            ...(options ?? {}),
+            headers,
+        });
+    }
+    /**
+     * Fetch provider/model/action capabilities used by the deployment onboarding flow.
+     */
+    async getExternalProviderCapabilities(options) {
+        return this.getV2ExternalProviderCapabilities(options);
+    }
+    /**
+     * Fetch provider/model/action capabilities from /v2/external/providers/capabilities.
+     */
+    async getV2ExternalProviderCapabilities(options) {
+        return this.get(this.buildV2Url('external/providers/capabilities'), options);
+    }
+    /**
+     * Validate onboarding provider credentials without storing secrets in the SDK.
+     */
+    async validateDeploymentProviders(payload, options) {
+        return this.validateV2ExternalDeploymentProviders(payload, options);
+    }
+    /**
+     * Validate onboarding provider credentials through /v2/external/providers/validate.
+     */
+    async validateV2ExternalDeploymentProviders(payload, options) {
+        return this.post(this.buildV2Url('external/providers/validate'), payload, options);
+    }
+    /**
+     * OpenAI-compatible external chat request billed through Samsar credits.
+     * This calls POST /external/chat.
+     */
+    async createExternalChat(payload, options) {
+        return this.createV2ExternalChat(payload, options);
+    }
+    /**
+     * OpenAI-compatible external chat request billed through Samsar credits.
+     * This calls POST /v2/external/chat.
+     */
+    async createV2ExternalChat(payload, options) {
+        return this.post(this.buildV2Url('external/chat'), payload, options);
+    }
+    /**
+     * OpenAI-compatible external chat completion billed through Samsar credits.
+     */
+    async createExternalChatCompletion(payload, options) {
+        return this.createV2ExternalChatCompletion(payload, options);
+    }
+    /**
+     * OpenAI-compatible external chat completion billed through Samsar credits.
+     * This calls POST /v2/external/chat/completions.
+     */
+    async createV2ExternalChatCompletion(payload, options) {
+        return this.post(this.buildV2Url('external/chat/completions'), payload, options);
+    }
+    /**
+     * Low-level wrapper for POST /v2/external/image/{path}. The external image surface mirrors
+     * the existing image API paths, for example assign_title, enhance, remove_branding,
+     * add_image_set, create_rollup_banner, and receipt_templates/query.
+     */
+    async requestExternalImage(path, payload = {}, options) {
+        return this.requestV2ExternalImage(path, payload, options);
+    }
+    /**
+     * Low-level wrapper for POST /v2/external/image/{path}.
+     */
+    async requestV2ExternalImage(path, payload = {}, options) {
+        return this.post(this.buildV2Url(`external/image/${normalizeExternalRoutePath(path)}`), payload, options);
+    }
+    /**
+     * Retrieve status for an async /external/image request.
+     */
+    async getExternalImageStatus(requestId, options) {
+        return this.getV2ExternalImageStatus(requestId, options);
+    }
+    /**
+     * Retrieve status for an async /v2/external/image request.
+     */
+    async getV2ExternalImageStatus(requestId, options) {
+        return this.getStatus(requestId, {
+            ...options,
+            path: this.buildV2Url('external/image/status'),
+        });
+    }
+    /**
+     * Low-level wrapper for POST /v2/external/video/{path}. The external video surface mirrors
+     * the existing video API paths, including text_to_video, image_list_to_video,
+     * upload_image_data, update_outro_image, translate_video, join_videos, and clone.
+     */
+    async requestExternalVideo(path, payload = {}, options) {
+        return this.requestV2ExternalVideo(path, payload, options);
+    }
+    /**
+     * Low-level wrapper for POST /v2/external/video/{path}.
+     */
+    async requestV2ExternalVideo(path, payload = {}, options) {
+        return this.post(this.buildV2Url(`external/video/${normalizeExternalRoutePath(path)}`), payload, options);
+    }
+    /**
+     * Create a central /v2/external/video text-to-video request using the same input shape as createVideoFromText.
+     */
+    async createExternalVideoRequestFromText(input, options) {
+        return this.createV2ExternalVideoRequestFromText(input, options);
+    }
+    /**
+     * Create a central /v2/external/video text-to-video request using the same input shape as createVideoFromText.
+     */
+    async createV2ExternalVideoRequestFromText(input, options) {
+        const normalizedInput = normalizeCreateVideoFromTextInput(input);
+        return this.requestV2ExternalVideo('text_to_video', {
+            input: normalizedInput,
+            webhookUrl: options?.webhookUrl,
+        }, options);
+    }
+    /**
+     * Create a central /v2/external/video image-list-to-video request using the same input shape as createVideoFromImageList.
+     */
+    async createExternalVideoRequestFromImageList(input, options) {
+        return this.createV2ExternalVideoRequestFromImageList(input, options);
+    }
+    /**
+     * Create a central /v2/external/video image-list-to-video request using the same input shape as createVideoFromImageList.
+     */
+    async createV2ExternalVideoRequestFromImageList(input, options) {
+        const normalizedInput = normalizeCreateVideoFromImageListInput(input);
+        return this.requestV2ExternalVideo('image_list_to_video', {
+            input: normalizedInput,
+            webhookUrl: options?.webhookUrl,
+        }, options);
+    }
+    /**
+     * Retrieve status for an async /external/video request.
+     */
+    async getExternalVideoStatus(requestId, options) {
+        return this.getV2ExternalVideoStatus(requestId, options);
+    }
+    /**
+     * Retrieve status for an async /v2/external/video request.
+     */
+    async getV2ExternalVideoStatus(requestId, options) {
+        return this.getStatus(requestId, {
+            ...options,
+            path: this.buildV2Url('external/video/status'),
+        });
+    }
+    /**
+     * Reserved wrapper for POST /v2/external/audio. The processor currently returns 501 until
+     * the external audio request schema is enabled.
+     */
+    async requestExternalAudio(payload = {}, options) {
+        return this.requestV2ExternalAudio(payload, options);
+    }
+    /**
+     * Reserved wrapper for POST /v2/external/audio. The processor currently returns 501 until
+     * the external audio request schema is enabled.
+     */
+    async requestV2ExternalAudio(payload = {}, options) {
+        return this.post(this.buildV2Url('external/audio'), payload, options);
+    }
     async get(path, options) {
         return this.request(path, { ...(options ?? {}), method: 'GET' });
     }
@@ -2394,6 +2567,13 @@ export class SamsarClient {
 function trimTrailingSlash(url) {
     return url.replace(/\/+$/, '');
 }
+function normalizeExternalRoutePath(path) {
+    const cleanedPath = String(path || '').trim().replace(/^\/+|\/+$/g, '');
+    if (!cleanedPath) {
+        throw new Error('external route path is required');
+    }
+    return cleanedPath;
+}
 function buildAssignImageTitleBody(payload) {
     if (isFormDataBody(payload)) {
         return payload;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "samsar-js",
-  "version": "0.48.34",
+  "version": "0.48.36",
   "description": "TypeScript client for the Samsar Processor API routes.",
   "type": "module",
   "main": "dist/index.js",