@breeze.blue/sdk 0.13.0 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.14.0
+
+- Added `account.currentApiKey()` for checking the authenticating key's status
+  and current Key Budget counters before starting work.
+
 ## 0.13.0
 
 - `voices.random(...)` accepts optional `languageCode` and `voiceType`

package/README.md

@@ -530,6 +530,8 @@ language-to-accent cascade at runtime.
 ```ts
 const models = await client.models.list();
 const balance = await client.account.balance();
+const currentKey = (await client.account.currentApiKey()).apiKey;
+console.log(currentKey.status, currentKey.creditRemaining);
 const usage = await client.account.usage({ days: 7 });
 const keyUsage = await client.account.usage({
   apiKeyId: "key_01hprod",

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { AudioResponse } from "./audio.js";
-import type { AudioRequestOptions, BreezeBlueWebSocket, AsyncTextToSpeechJob, Balance, BreezeBlueClientOptions, GenericStatus, GenerationJob, HistoryItem, HistoryList, HistoryListParams, Model, RequestOptions, RealtimeTextToSpeechConnectOptions, RealtimeTextToSpeechEvent, RealtimeTextToSpeechManagedConnectOptions, RealtimeTextToSpeechMessage, RealtimeTextToSpeechSession, RealtimeTextToSpeechSessionRequest, SavedVoice, SaveVoiceRequest, StreamTextToSpeechOptions, TextToSpeechRequest, TtsEnhanceRequest, TtsEnhanceResponse, Usage, UsageParams, Voice, VoiceClonePreview, VoiceClonePreviewRequest, VoiceDesignRequest, VoiceDesignResponse, VoiceDesignStreamRequest, VoiceEditRequest, VoiceList, VoiceMetadataOptions, VoiceRandomParams, VoiceSearchParams, VoiceSettings } from "./types.js";
+import type { AudioRequestOptions, BreezeBlueWebSocket, AsyncTextToSpeechJob, Balance, BreezeBlueClientOptions, CurrentApiKeyResponse, GenericStatus, GenerationJob, HistoryItem, HistoryList, HistoryListParams, Model, RequestOptions, RealtimeTextToSpeechConnectOptions, RealtimeTextToSpeechEvent, RealtimeTextToSpeechManagedConnectOptions, RealtimeTextToSpeechMessage, RealtimeTextToSpeechSession, RealtimeTextToSpeechSessionRequest, SavedVoice, SaveVoiceRequest, StreamTextToSpeechOptions, TextToSpeechRequest, TtsEnhanceRequest, TtsEnhanceResponse, Usage, UsageParams, Voice, VoiceClonePreview, VoiceClonePreviewRequest, VoiceDesignRequest, VoiceDesignResponse, VoiceDesignStreamRequest, VoiceEditRequest, VoiceList, VoiceMetadataOptions, VoiceRandomParams, VoiceSearchParams, VoiceSettings } from "./types.js";
 export declare class BreezeBlueClient {
     readonly apiKey: string | undefined;
     readonly baseUrl: string;
@@ -267,6 +267,8 @@ declare class AccountResource {
     private readonly client;
     constructor(client: BreezeBlueClient);
     balance(options?: RequestOptions): Promise<Balance>;
+    /** Return the authenticating API key and its current Key Budget counters. */
+    currentApiKey(options?: RequestOptions): Promise<CurrentApiKeyResponse>;
     usage(params?: UsageParams, options?: RequestOptions): Promise<Usage>;
 }
 export {};

package/dist/client.js

@@ -1625,6 +1625,10 @@ class AccountResource {
     balance(options) {
         return this.client.requestJson("GET", "/v1/balance", undefined, undefined, options);
     }
+    /** Return the authenticating API key and its current Key Budget counters. */
+    currentApiKey(options) {
+        return this.client.requestJson("GET", "/v1/api-keys/current", undefined, undefined, options);
+    }
     usage(params = {}, options) {
         return this.client.requestJson("GET", "/v1/usage", params, undefined, options);
     }

package/dist/types.d.ts

@@ -508,6 +508,19 @@ export interface Balance {
     topups: BalanceTopup[];
     [key: string]: unknown;
 }
+export interface CurrentApiKey {
+    id: string;
+    name: string;
+    prefix: string;
+    status: string;
+    creditLimit?: number | null;
+    creditUsed?: number;
+    creditReserved?: number;
+    creditRemaining?: number | null;
+}
+export interface CurrentApiKeyResponse {
+    apiKey: CurrentApiKey;
+}
 export interface UsageSummary {
     requestCount: number;
     totalTextCharacters: number;

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "0.13.0";
+export declare const SDK_VERSION = "0.14.0";
 export declare const SDK_NAME = "@breeze.blue/sdk";

package/dist/version.js

@@ -1,2 +1,2 @@
-export const SDK_VERSION = "0.13.0";
+export const SDK_VERSION = "0.14.0";
 export const SDK_NAME = "@breeze.blue/sdk";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breeze.blue/sdk",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "ESM-first TypeScript SDK for the Breeze Blue Developer API.",
   "license": "MIT",
   "author": "Breeze Blue <support@breezeblue.ai>",