@rynko/sdk 1.1.0 → 1.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.
- package/README.md +12 -4
- package/dist/index.js +2 -2
- package/dist/index.mjs +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -449,14 +449,22 @@ app.post('/webhooks/rynko', express.raw({ type: 'application/json' }), (req, res
|
|
|
449
449
|
|
|
450
450
|
switch (event.type) {
|
|
451
451
|
case 'document.generated':
|
|
452
|
-
const { jobId, downloadUrl, templateId } = event.data;
|
|
452
|
+
const { jobId, downloadUrl, templateId, metadata } = event.data;
|
|
453
453
|
console.log(`Document ${jobId} ready: ${downloadUrl}`);
|
|
454
|
+
// Access metadata you passed during generation
|
|
455
|
+
if (metadata) {
|
|
456
|
+
console.log(`Order ID: ${metadata.orderId}`);
|
|
457
|
+
}
|
|
454
458
|
// Download or process the document
|
|
455
459
|
break;
|
|
456
460
|
|
|
457
461
|
case 'document.failed':
|
|
458
|
-
const { jobId: failedJobId, error, errorCode } = event.data;
|
|
462
|
+
const { jobId: failedJobId, error, errorCode, metadata: failedMeta } = event.data;
|
|
459
463
|
console.error(`Document ${failedJobId} failed: ${error}`);
|
|
464
|
+
// Access metadata for correlation
|
|
465
|
+
if (failedMeta) {
|
|
466
|
+
console.log(`Failed order: ${failedMeta.orderId}`);
|
|
467
|
+
}
|
|
460
468
|
// Handle failure (retry, notify user, etc.)
|
|
461
469
|
break;
|
|
462
470
|
|
|
@@ -486,8 +494,8 @@ app.post('/webhooks/rynko', express.raw({ type: 'application/json' }), (req, res
|
|
|
486
494
|
|
|
487
495
|
| Event | Description | Payload |
|
|
488
496
|
|-------|-------------|---------|
|
|
489
|
-
| `document.generated` | Document successfully generated | `jobId`, `templateId`, `format`, `downloadUrl`, `fileSize` |
|
|
490
|
-
| `document.failed` | Document generation failed | `jobId`, `templateId`, `error`, `errorCode` |
|
|
497
|
+
| `document.generated` | Document successfully generated | `jobId`, `templateId`, `format`, `downloadUrl`, `fileSize`, `metadata` |
|
|
498
|
+
| `document.failed` | Document generation failed | `jobId`, `templateId`, `error`, `errorCode`, `metadata` |
|
|
491
499
|
| `document.downloaded` | Document was downloaded | `jobId`, `downloadedAt` |
|
|
492
500
|
|
|
493
501
|
#### Webhook Headers
|
package/dist/index.js
CHANGED
|
@@ -237,7 +237,7 @@ var DocumentsResource = class {
|
|
|
237
237
|
async generate(options) {
|
|
238
238
|
return this.http.post(
|
|
239
239
|
"/api/v1/documents/generate",
|
|
240
|
-
options
|
|
240
|
+
{ ...options, source: "sdk_node" }
|
|
241
241
|
);
|
|
242
242
|
}
|
|
243
243
|
/**
|
|
@@ -304,7 +304,7 @@ var DocumentsResource = class {
|
|
|
304
304
|
async generateBatch(options) {
|
|
305
305
|
return this.http.post(
|
|
306
306
|
"/api/v1/documents/generate/batch",
|
|
307
|
-
options
|
|
307
|
+
{ ...options, source: "sdk_node" }
|
|
308
308
|
);
|
|
309
309
|
}
|
|
310
310
|
/**
|
package/dist/index.mjs
CHANGED
|
@@ -202,7 +202,7 @@ var DocumentsResource = class {
|
|
|
202
202
|
async generate(options) {
|
|
203
203
|
return this.http.post(
|
|
204
204
|
"/api/v1/documents/generate",
|
|
205
|
-
options
|
|
205
|
+
{ ...options, source: "sdk_node" }
|
|
206
206
|
);
|
|
207
207
|
}
|
|
208
208
|
/**
|
|
@@ -269,7 +269,7 @@ var DocumentsResource = class {
|
|
|
269
269
|
async generateBatch(options) {
|
|
270
270
|
return this.http.post(
|
|
271
271
|
"/api/v1/documents/generate/batch",
|
|
272
|
-
options
|
|
272
|
+
{ ...options, source: "sdk_node" }
|
|
273
273
|
);
|
|
274
274
|
}
|
|
275
275
|
/**
|