@korala/api-client 1.13.0 → 1.15.0

package/README.md

@@ -97,6 +97,30 @@ const result = await client.documents.bulkSign({
 console.log(`${result.signed} signed, ${result.failed} failed`);
 ```
 
+### Create a signing packet
+
+Use the authenticated management API to give one recipient a Korala-hosted
+flow for up to 50 documents. The API key prepares and sends the packet; the
+recipient verifies their email and authorizes the signatures in Korala.
+
+```typescript
+const packet = await client.signingPackets.create({
+  name: 'Series A closing',
+  recipient: { name: 'Alex Manager', email: 'alex@example.com' },
+  items: [
+    { documentId: subscription.id, signerId: subscriptionSigner.id },
+    { documentId: sideLetter.id, signerId: sideLetterSigner.id },
+  ],
+  redirectUrl: 'https://fund.example.com/closing/complete',
+});
+
+const sent = await client.signingPackets.send(packet.id, {
+  delivery: 'email',
+});
+
+console.log(sent.signingUrl);
+```
+
 ### Webhooks
 
 ```typescript
@@ -114,6 +138,7 @@ const webhook = await client.webhooks.create({
 | `client.signers` | `list`, `create` |
 | `client.fields` | `list`, `create`, `update`, `delete` |
 | `client.signatures` | `list`, `get`, `create`, `delete` |
+| `client.signingPackets` | `create`, `get`, `update`, `send`, `remind`, `void`, `audit` |
 | `client.templates` | `list`, `get`, `createDocument`, `generate` |
 | `client.webhooks` | `list`, `get`, `create`, `update`, `delete` |
 

package/dist/client.d.ts

@@ -4,6 +4,7 @@ import { FieldsResource } from './resources/fields.js';
 import { SessionsResource } from './resources/sessions.js';
 import { SignaturesResource } from './resources/signatures.js';
 import { SignersResource } from './resources/signers.js';
+import { SigningPacketsResource } from './resources/signing-packets.js';
 import { TemplatesResource } from './resources/templates.js';
 import { WebhooksResource } from './resources/webhooks.js';
 import { WorkflowsResource } from './resources/workflows.js';
@@ -19,6 +20,7 @@ export declare class KoralaClient {
     readonly signers: SignersResource;
     readonly fields: FieldsResource;
     readonly signatures: SignaturesResource;
+    readonly signingPackets: SigningPacketsResource;
     readonly templates: TemplatesResource;
     readonly webhooks: WebhooksResource;
     readonly workflows: WorkflowsResource;

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAKD,qBAAa,YAAY;IACvB,SAAgB,OAAO,EAAE,eAAe,CAAC;IACzC,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,OAAO,EAAE,eAAe,CAAC;IACzC,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,SAAgB,UAAU,EAAE,kBAAkB,CAAC;IAC/C,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAC3C,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAE3C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;gBAEtB,MAAM,EAAE,kBAAkB;CAkBvC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAKD,qBAAa,YAAY;IACvB,SAAgB,OAAO,EAAE,eAAe,CAAC;IACzC,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,OAAO,EAAE,eAAe,CAAC;IACzC,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,SAAgB,UAAU,EAAE,kBAAkB,CAAC;IAC/C,SAAgB,cAAc,EAAE,sBAAsB,CAAC;IACvD,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAC3C,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAE3C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;gBAEtB,MAAM,EAAE,kBAAkB;CAmBvC"}

package/dist/client.js

@@ -8,6 +8,7 @@ const fields_js_1 = require("./resources/fields.js");
 const sessions_js_1 = require("./resources/sessions.js");
 const signatures_js_1 = require("./resources/signatures.js");
 const signers_js_1 = require("./resources/signers.js");
+const signing_packets_js_1 = require("./resources/signing-packets.js");
 const templates_js_1 = require("./resources/templates.js");
 const webhooks_js_1 = require("./resources/webhooks.js");
 const workflows_js_1 = require("./resources/workflows.js");
@@ -19,6 +20,7 @@ class KoralaClient {
     signers;
     fields;
     signatures;
+    signingPackets;
     templates;
     webhooks;
     workflows;
@@ -36,6 +38,7 @@ class KoralaClient {
         this.signers = new signers_js_1.SignersResource(this.http);
         this.fields = new fields_js_1.FieldsResource(this.http);
         this.signatures = new signatures_js_1.SignaturesResource(this.http);
+        this.signingPackets = new signing_packets_js_1.SigningPacketsResource(this.http);
         this.templates = new templates_js_1.TemplatesResource(this.http);
         this.webhooks = new webhooks_js_1.WebhooksResource(this.http);
         this.workflows = new workflows_js_1.WorkflowsResource(this.http);

package/dist/resources/signing-packets.d.ts

@@ -0,0 +1,16 @@
+import type { CreateSigningPacketDto, SendSigningPacketDto, SigningPacketAuditDto, SigningPacketDto, UpdateSigningPacketDto } from '@korala/public-dtos';
+import type { HttpClient } from '../http.js';
+export declare class SigningPacketsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    create(data: CreateSigningPacketDto): Promise<SigningPacketDto>;
+    get(id: string): Promise<SigningPacketDto>;
+    update(id: string, data: UpdateSigningPacketDto): Promise<SigningPacketDto>;
+    send(id: string, data?: SendSigningPacketDto): Promise<SigningPacketDto>;
+    remind(id: string): Promise<SigningPacketDto>;
+    void(id: string): Promise<{
+        success: boolean;
+    }>;
+    audit(id: string): Promise<SigningPacketAuditDto>;
+}
+//# sourceMappingURL=signing-packets.d.ts.map

package/dist/resources/signing-packets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signing-packets.d.ts","sourceRoot":"","sources":["../../src/resources/signing-packets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,qBAAa,sBAAsB;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,MAAM,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI/D,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI1C,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI3E,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,GAAE,oBAAyB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAO5E,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI7C,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAI/C,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAGlD"}

package/dist/resources/signing-packets.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SigningPacketsResource = void 0;
+class SigningPacketsResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    create(data) {
+        return this.http.post('/signing-packets', data);
+    }
+    get(id) {
+        return this.http.get(`/signing-packets/${id}`);
+    }
+    update(id, data) {
+        return this.http.patch(`/signing-packets/${id}`, data);
+    }
+    send(id, data = {}) {
+        return this.http.post(`/signing-packets/${id}/send`, data);
+    }
+    remind(id) {
+        return this.http.post(`/signing-packets/${id}/remind`);
+    }
+    void(id) {
+        return this.http.post(`/signing-packets/${id}/void`);
+    }
+    audit(id) {
+        return this.http.get(`/signing-packets/${id}/audit`);
+    }
+}
+exports.SigningPacketsResource = SigningPacketsResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@korala/api-client",
-  "version": "1.13.0",
+  "version": "1.15.0",
   "description": "TypeScript API client for Korala document signing API",
   "license": "MIT",
   "homepage": "https://docs.korala.ai",
@@ -29,8 +29,8 @@
     "typescript"
   ],
   "dependencies": {
-    "@korala/public-dtos": "^1.13.0",
-    "@korala/auth": "^1.1.0"
+    "@korala/auth": "^1.1.0",
+    "@korala/public-dtos": "^1.15.0"
   },
   "devDependencies": {
     "typescript": "^5.9.3"