@hedra/sdk 5.0.0 → 5.2.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.
Files changed (69) hide show
  1. package/README.md +196 -49
  2. package/dist/cjs/BaseClient.d.ts +2 -2
  3. package/dist/cjs/BaseClient.js +3 -3
  4. package/dist/cjs/api/resources/billing/client/Client.js +3 -3
  5. package/dist/cjs/api/resources/files/client/Client.js +1 -1
  6. package/dist/cjs/api/resources/jobs/client/Client.d.ts +73 -0
  7. package/dist/cjs/api/resources/jobs/client/Client.js +274 -97
  8. package/dist/cjs/api/resources/jobs/client/requests/SubmitBodyCreatifyAurora.d.ts +24 -0
  9. package/dist/cjs/api/resources/jobs/client/requests/SubmitBodyCreatifyAurora.js +3 -0
  10. package/dist/cjs/api/resources/jobs/client/requests/SubmitBodyHeygenPhotoAvatar4.d.ts +25 -0
  11. package/dist/cjs/api/resources/jobs/client/requests/SubmitBodyHeygenPhotoAvatar4.js +3 -0
  12. package/dist/cjs/api/resources/jobs/client/requests/index.d.ts +2 -0
  13. package/dist/cjs/api/resources/keys/client/Client.js +4 -4
  14. package/dist/cjs/api/resources/logDrains/client/Client.js +6 -6
  15. package/dist/cjs/api/resources/models/client/Client.js +7 -7
  16. package/dist/cjs/api/resources/tokens/client/Client.js +1 -1
  17. package/dist/cjs/api/resources/webhooks/client/Client.js +7 -7
  18. package/dist/cjs/api/types/InputCreatifyAurora.d.ts +24 -0
  19. package/dist/cjs/api/types/InputCreatifyAurora.js +12 -0
  20. package/dist/cjs/api/types/InputCreatifyAuroraAudio.d.ts +23 -0
  21. package/dist/cjs/api/types/InputCreatifyAuroraAudio.js +3 -0
  22. package/dist/cjs/api/types/InputCreatifyAuroraStartImage.d.ts +23 -0
  23. package/dist/cjs/api/types/InputCreatifyAuroraStartImage.js +3 -0
  24. package/dist/cjs/api/types/InputGptImage2.d.ts +1 -1
  25. package/dist/cjs/api/types/InputHeygenPhotoAvatar4.d.ts +39 -0
  26. package/dist/cjs/api/types/InputHeygenPhotoAvatar4.js +24 -0
  27. package/dist/cjs/api/types/InputHeygenPhotoAvatar4Audio.d.ts +23 -0
  28. package/dist/cjs/api/types/InputHeygenPhotoAvatar4Audio.js +3 -0
  29. package/dist/cjs/api/types/InputHeygenPhotoAvatar4StartImage.d.ts +23 -0
  30. package/dist/cjs/api/types/InputHeygenPhotoAvatar4StartImage.js +3 -0
  31. package/dist/cjs/api/types/index.d.ts +6 -0
  32. package/dist/cjs/api/types/index.js +6 -0
  33. package/dist/cjs/version.d.ts +1 -1
  34. package/dist/cjs/version.js +1 -1
  35. package/dist/esm/BaseClient.d.mts +2 -2
  36. package/dist/esm/BaseClient.mjs +3 -3
  37. package/dist/esm/api/resources/billing/client/Client.mjs +3 -3
  38. package/dist/esm/api/resources/files/client/Client.mjs +1 -1
  39. package/dist/esm/api/resources/jobs/client/Client.d.mts +73 -0
  40. package/dist/esm/api/resources/jobs/client/Client.mjs +274 -97
  41. package/dist/esm/api/resources/jobs/client/requests/SubmitBodyCreatifyAurora.d.mts +24 -0
  42. package/dist/esm/api/resources/jobs/client/requests/SubmitBodyCreatifyAurora.mjs +2 -0
  43. package/dist/esm/api/resources/jobs/client/requests/SubmitBodyHeygenPhotoAvatar4.d.mts +25 -0
  44. package/dist/esm/api/resources/jobs/client/requests/SubmitBodyHeygenPhotoAvatar4.mjs +2 -0
  45. package/dist/esm/api/resources/jobs/client/requests/index.d.mts +2 -0
  46. package/dist/esm/api/resources/keys/client/Client.mjs +4 -4
  47. package/dist/esm/api/resources/logDrains/client/Client.mjs +6 -6
  48. package/dist/esm/api/resources/models/client/Client.mjs +7 -7
  49. package/dist/esm/api/resources/tokens/client/Client.mjs +1 -1
  50. package/dist/esm/api/resources/webhooks/client/Client.mjs +7 -7
  51. package/dist/esm/api/types/InputCreatifyAurora.d.mts +24 -0
  52. package/dist/esm/api/types/InputCreatifyAurora.mjs +9 -0
  53. package/dist/esm/api/types/InputCreatifyAuroraAudio.d.mts +23 -0
  54. package/dist/esm/api/types/InputCreatifyAuroraAudio.mjs +2 -0
  55. package/dist/esm/api/types/InputCreatifyAuroraStartImage.d.mts +23 -0
  56. package/dist/esm/api/types/InputCreatifyAuroraStartImage.mjs +2 -0
  57. package/dist/esm/api/types/InputGptImage2.d.mts +1 -1
  58. package/dist/esm/api/types/InputHeygenPhotoAvatar4.d.mts +39 -0
  59. package/dist/esm/api/types/InputHeygenPhotoAvatar4.mjs +21 -0
  60. package/dist/esm/api/types/InputHeygenPhotoAvatar4Audio.d.mts +23 -0
  61. package/dist/esm/api/types/InputHeygenPhotoAvatar4Audio.mjs +2 -0
  62. package/dist/esm/api/types/InputHeygenPhotoAvatar4StartImage.d.mts +23 -0
  63. package/dist/esm/api/types/InputHeygenPhotoAvatar4StartImage.mjs +2 -0
  64. package/dist/esm/api/types/index.d.mts +6 -0
  65. package/dist/esm/api/types/index.mjs +6 -0
  66. package/dist/esm/version.d.mts +1 -1
  67. package/dist/esm/version.mjs +1 -1
  68. package/package.json +2 -2
  69. package/reference.md +155 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hedra/sdk",
3
- "version": "5.0.0",
3
+ "version": "5.2.0",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
@@ -155,6 +155,6 @@
155
155
  "node": ">=18.0.0"
156
156
  },
157
157
  "sideEffects": false,
158
- "description": "The official TypeScript library for the Hedra API — API spec 3.16.0",
158
+ "description": "The official TypeScript library for the Hedra API — API spec 3.16.2",
159
159
  "author": "Hedra <support@hedra.com>"
160
160
  }
package/reference.md CHANGED
@@ -300,6 +300,83 @@ for await (const item of response) {
300
300
  </dl>
301
301
 
302
302
 
303
+ </dd>
304
+ </dl>
305
+ </details>
306
+
307
+ <details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">submitCreatifyAurora</a>({ ...params }) -> Hedra.SubmitResponse</code></summary>
308
+ <dl>
309
+ <dd>
310
+
311
+ #### 📝 Description
312
+
313
+ <dl>
314
+ <dd>
315
+
316
+ <dl>
317
+ <dd>
318
+
319
+ Create high-fidelity speaking or singing avatar videos.
320
+
321
+ Submits an asynchronous job and returns `202` with a job id. Fetch the result at `GET /v3/jobs/{job_id}` — each item in its `outputs[]` follows the `OutputItem` schema — or track progress via `GET /v3/jobs/{job_id}/status` / the SSE stream at `GET /v3/jobs/{job_id}/stream`.
322
+ </dd>
323
+ </dl>
324
+ </dd>
325
+ </dl>
326
+
327
+ #### 🔌 Usage
328
+
329
+ <dl>
330
+ <dd>
331
+
332
+ <dl>
333
+ <dd>
334
+
335
+ ```typescript
336
+ await client.jobs.submitCreatifyAurora({
337
+ input: {
338
+ resolution: "480p",
339
+ start_image: {
340
+ source: "url",
341
+ url: "url"
342
+ },
343
+ audio: {
344
+ source: "url",
345
+ url: "url"
346
+ }
347
+ }
348
+ });
349
+
350
+ ```
351
+ </dd>
352
+ </dl>
353
+ </dd>
354
+ </dl>
355
+
356
+ #### ⚙️ Parameters
357
+
358
+ <dl>
359
+ <dd>
360
+
361
+ <dl>
362
+ <dd>
363
+
364
+ **request:** `Hedra.SubmitBodyCreatifyAurora`
365
+
366
+ </dd>
367
+ </dl>
368
+
369
+ <dl>
370
+ <dd>
371
+
372
+ **requestOptions:** `JobsClient.RequestOptions`
373
+
374
+ </dd>
375
+ </dl>
376
+ </dd>
377
+ </dl>
378
+
379
+
303
380
  </dd>
304
381
  </dl>
305
382
  </details>
@@ -2433,6 +2510,84 @@ await client.jobs.submitHedraCharacter3({
2433
2510
  </dl>
2434
2511
 
2435
2512
 
2513
+ </dd>
2514
+ </dl>
2515
+ </details>
2516
+
2517
+ <details><summary><code>client.jobs.<a href="/src/api/resources/jobs/client/Client.ts">submitHeygenPhotoAvatar4</a>({ ...params }) -> Hedra.SubmitResponse</code></summary>
2518
+ <dl>
2519
+ <dd>
2520
+
2521
+ #### 📝 Description
2522
+
2523
+ <dl>
2524
+ <dd>
2525
+
2526
+ <dl>
2527
+ <dd>
2528
+
2529
+ Turn a clear portrait and driving audio into a talking avatar.
2530
+
2531
+ Submits an asynchronous job and returns `202` with a job id. Fetch the result at `GET /v3/jobs/{job_id}` — each item in its `outputs[]` follows the `OutputItem` schema — or track progress via `GET /v3/jobs/{job_id}/status` / the SSE stream at `GET /v3/jobs/{job_id}/stream`.
2532
+ </dd>
2533
+ </dl>
2534
+ </dd>
2535
+ </dl>
2536
+
2537
+ #### 🔌 Usage
2538
+
2539
+ <dl>
2540
+ <dd>
2541
+
2542
+ <dl>
2543
+ <dd>
2544
+
2545
+ ```typescript
2546
+ await client.jobs.submitHeygenPhotoAvatar4({
2547
+ input: {
2548
+ aspect_ratio: "16:9",
2549
+ resolution: "360p",
2550
+ start_image: {
2551
+ source: "url",
2552
+ url: "url"
2553
+ },
2554
+ audio: {
2555
+ source: "url",
2556
+ url: "url"
2557
+ }
2558
+ }
2559
+ });
2560
+
2561
+ ```
2562
+ </dd>
2563
+ </dl>
2564
+ </dd>
2565
+ </dl>
2566
+
2567
+ #### ⚙️ Parameters
2568
+
2569
+ <dl>
2570
+ <dd>
2571
+
2572
+ <dl>
2573
+ <dd>
2574
+
2575
+ **request:** `Hedra.SubmitBodyHeygenPhotoAvatar4`
2576
+
2577
+ </dd>
2578
+ </dl>
2579
+
2580
+ <dl>
2581
+ <dd>
2582
+
2583
+ **requestOptions:** `JobsClient.RequestOptions`
2584
+
2585
+ </dd>
2586
+ </dl>
2587
+ </dd>
2588
+ </dl>
2589
+
2590
+
2436
2591
  </dd>
2437
2592
  </dl>
2438
2593
  </details>