@json-to-office/core-docx 0.3.1 → 0.6.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 (38) hide show
  1. package/dist/components/highcharts.d.ts +1 -1
  2. package/dist/components/highcharts.d.ts.map +1 -1
  3. package/dist/components/image.d.ts +1 -1
  4. package/dist/components/image.d.ts.map +1 -1
  5. package/dist/components/index.d.ts +0 -2
  6. package/dist/components/index.d.ts.map +1 -1
  7. package/dist/components/text-box.d.ts.map +1 -1
  8. package/dist/core/content.d.ts +10 -10
  9. package/dist/core/content.d.ts.map +1 -1
  10. package/dist/core/render.d.ts.map +1 -1
  11. package/dist/index.d.ts +1 -1
  12. package/dist/index.d.ts.map +1 -1
  13. package/dist/index.js +390 -421
  14. package/dist/index.js.map +1 -1
  15. package/dist/plugin/example/index.js +390 -419
  16. package/dist/plugin/example/index.js.map +1 -1
  17. package/dist/templates/documents/index.d.ts +0 -1
  18. package/dist/templates/documents/index.d.ts.map +1 -1
  19. package/dist/templates/documents/proposal.docx.json +801 -67
  20. package/dist/templates/documents/technical-guide.docx.json +1688 -75
  21. package/dist/templates/themes/apex.docx.theme.json +126 -0
  22. package/dist/templates/themes/devportal.docx.theme.json +134 -0
  23. package/dist/templates/themes/index.d.ts +32 -32
  24. package/dist/tsconfig.tsbuildinfo +1 -1
  25. package/dist/types/index.d.ts +3 -7
  26. package/dist/types/index.d.ts.map +1 -1
  27. package/dist/utils/docxImagePositioning.d.ts +2 -1
  28. package/dist/utils/docxImagePositioning.d.ts.map +1 -1
  29. package/dist/utils/imageUtils.d.ts +24 -4
  30. package/dist/utils/imageUtils.d.ts.map +1 -1
  31. package/dist/utils/widthUtils.d.ts +5 -0
  32. package/dist/utils/widthUtils.d.ts.map +1 -1
  33. package/package.json +2 -2
  34. package/dist/components/footer.d.ts +0 -12
  35. package/dist/components/footer.d.ts.map +0 -1
  36. package/dist/components/header.d.ts +0 -12
  37. package/dist/components/header.d.ts.map +0 -1
  38. package/dist/templates/documents/quarterly-report.docx.json +0 -117
@@ -1,73 +1,555 @@
1
1
  {
2
2
  "name": "docx",
3
3
  "props": {
4
- "metadata": { "title": "Platform Integration Guide" },
5
- "theme": "minimal"
4
+ "metadata": {
5
+ "title": "Arcline Platform — Integration Guide",
6
+ "author": "Arcline Engineering",
7
+ "description": "Technical reference for integrating external systems with the Arcline Platform API"
8
+ },
9
+ "theme": "devportal"
6
10
  },
7
11
  "children": [
8
12
  {
9
- "name": "header",
10
- "props": {
11
- "text": "Platform Integration Guide",
12
- "alignment": "left",
13
- "showPageNumbers": true
14
- }
15
- },
16
- {
17
- "name": "footer",
13
+ "name": "section",
18
14
  "props": {
19
- "text": "Confidential — TechCorp Inc.",
20
- "alignment": "center"
21
- }
15
+ "level": 1,
16
+ "header": [
17
+ {
18
+ "name": "paragraph",
19
+ "props": {
20
+ "text": "Arcline Platform — Integration Guide v3.2",
21
+ "alignment": "left"
22
+ }
23
+ }
24
+ ],
25
+ "footer": [
26
+ {
27
+ "name": "paragraph",
28
+ "props": {
29
+ "text": "Confidential — Arcline Inc. — Do not distribute",
30
+ "alignment": "center"
31
+ }
32
+ }
33
+ ]
34
+ },
35
+ "children": [
36
+ {
37
+ "name": "heading",
38
+ "props": {
39
+ "text": "Platform Integration Guide",
40
+ "level": 1
41
+ }
42
+ },
43
+ {
44
+ "name": "heading",
45
+ "props": {
46
+ "text": "Arcline API v3.2 — Technical Reference",
47
+ "level": 2
48
+ }
49
+ },
50
+ {
51
+ "name": "paragraph",
52
+ "props": {
53
+ "text": "Last updated: April 2026 | Audience: Developers, System Architects, DevOps Engineers",
54
+ "font": {
55
+ "italic": true,
56
+ "color": "textSecondary"
57
+ }
58
+ }
59
+ },
60
+ {
61
+ "name": "paragraph",
62
+ "props": {
63
+ "text": ""
64
+ }
65
+ },
66
+ {
67
+ "name": "image",
68
+ "props": {
69
+ "path": "https://placehold.co/800x200/0F172A/0D9488?text=ARCLINE+PLATFORM&font=helvetica",
70
+ "width": "100%",
71
+ "caption": "Arcline — Enterprise Data Platform"
72
+ }
73
+ },
74
+ {
75
+ "name": "paragraph",
76
+ "props": {
77
+ "text": ""
78
+ }
79
+ },
80
+ {
81
+ "name": "paragraph",
82
+ "props": {
83
+ "text": "This guide covers the integration of external systems with the Arcline Platform API. It is intended for developers and system architects building custom integrations, data pipelines, and embedded analytics solutions. The API follows RESTful conventions, uses OAuth 2.0 for authentication, and returns JSON responses."
84
+ }
85
+ },
86
+ {
87
+ "name": "toc",
88
+ "props": {
89
+ "depth": {
90
+ "from": 1,
91
+ "to": 2
92
+ }
93
+ }
94
+ }
95
+ ]
22
96
  },
23
- { "name": "toc", "props": { "depth": { "from": 1, "to": 2 } } },
24
97
  {
25
98
  "name": "section",
26
- "props": { "level": 1, "pageBreak": true },
99
+ "props": {
100
+ "level": 1,
101
+ "pageBreak": true,
102
+ "header": "linkToPrevious",
103
+ "footer": "linkToPrevious"
104
+ },
27
105
  "children": [
28
- { "name": "heading", "props": { "text": "Introduction", "level": 1 } },
29
- { "name": "paragraph", "props": { "text": "This guide covers the integration of external systems with the Platform API. It is intended for developers and system architects building custom integrations." } },
30
- { "name": "heading", "props": { "text": "Prerequisites", "level": 2 } },
106
+ {
107
+ "name": "heading",
108
+ "props": {
109
+ "text": "Getting Started",
110
+ "level": 1
111
+ }
112
+ },
113
+ {
114
+ "name": "heading",
115
+ "props": {
116
+ "text": "Prerequisites",
117
+ "level": 2
118
+ }
119
+ },
31
120
  {
32
121
  "name": "list",
33
122
  "props": {
34
123
  "format": "bullet",
35
124
  "items": [
36
- "API key with admin scope (Settings > API Keys)",
37
- "Node.js 18+ or Python 3.10+",
38
- "Network access to api.platform.io on port 443",
39
- "Familiarity with REST APIs and OAuth 2.0"
125
+ "Arcline account with API access enabled (Settings > API Keys > Generate)",
126
+ "Node.js 20+ or Python 3.11+ (official SDKs available for both)",
127
+ "Network access to api.arcline.io on port 443 (TLS 1.3 required)",
128
+ "Familiarity with REST APIs, OAuth 2.0 client credentials flow, and webhook architectures"
40
129
  ]
41
130
  }
42
131
  },
43
- { "name": "heading", "props": { "text": "Architecture Overview", "level": 2 } },
44
- { "name": "paragraph", "props": { "text": "The platform exposes a RESTful API organized around resources. All endpoints accept and return JSON. Authentication uses OAuth 2.0 bearer tokens with configurable scopes." } },
132
+ {
133
+ "name": "heading",
134
+ "props": {
135
+ "text": "Architecture Overview",
136
+ "level": 2
137
+ }
138
+ },
139
+ {
140
+ "name": "paragraph",
141
+ "props": {
142
+ "text": "The Arcline Platform exposes a RESTful API organized around resources. All endpoints accept and return JSON. Authentication uses OAuth 2.0 bearer tokens with configurable scopes. Rate limiting is applied per-token with configurable burst allowances."
143
+ }
144
+ },
45
145
  {
46
146
  "name": "image",
47
147
  "props": {
48
- "path": "https://placehold.co/800x400/f1f5f9/475569?text=Architecture+Diagram",
148
+ "path": "https://placehold.co/800x400/F8FAFC/0F172A?text=API+Gateway+%E2%86%92+Auth+Service+%E2%86%92+Microservices+%E2%86%92+Data+Layer&font=helvetica",
49
149
  "width": "100%",
50
- "caption": "Figure 1: High-level architecture showing API gateway, services, and data flow"
150
+ "caption": "Figure 1: High-level architecture API gateway, authentication layer, microservices, and data stores"
151
+ }
152
+ },
153
+ {
154
+ "name": "heading",
155
+ "props": {
156
+ "text": "Base URL & Environments",
157
+ "level": 2
158
+ }
159
+ },
160
+ {
161
+ "name": "table",
162
+ "props": {
163
+ "headerCellDefaults": {
164
+ "font": {
165
+ "bold": true,
166
+ "size": 10
167
+ },
168
+ "padding": {
169
+ "top": 8,
170
+ "right": 10,
171
+ "bottom": 8,
172
+ "left": 10
173
+ }
174
+ },
175
+ "cellDefaults": {
176
+ "padding": {
177
+ "top": 5,
178
+ "right": 10,
179
+ "bottom": 5,
180
+ "left": 10
181
+ },
182
+ "verticalAlignment": "middle",
183
+ "font": {
184
+ "size": 10
185
+ }
186
+ },
187
+ "borderColor": "E2E8F0",
188
+ "borderSize": 1,
189
+ "hideBorders": {
190
+ "insideVertical": true
191
+ },
192
+ "columns": [
193
+ {
194
+ "header": {
195
+ "content": "Environment"
196
+ },
197
+ "cells": [
198
+ {
199
+ "content": "Production"
200
+ },
201
+ {
202
+ "content": "Staging"
203
+ },
204
+ {
205
+ "content": "Sandbox"
206
+ }
207
+ ]
208
+ },
209
+ {
210
+ "header": {
211
+ "content": "Base URL"
212
+ },
213
+ "cells": [
214
+ {
215
+ "content": "https://api.arcline.io/v3",
216
+ "font": {
217
+ "family": "Consolas"
218
+ }
219
+ },
220
+ {
221
+ "content": "https://staging-api.arcline.io/v3",
222
+ "font": {
223
+ "family": "Consolas"
224
+ }
225
+ },
226
+ {
227
+ "content": "https://sandbox-api.arcline.io/v3",
228
+ "font": {
229
+ "family": "Consolas"
230
+ }
231
+ }
232
+ ]
233
+ },
234
+ {
235
+ "header": {
236
+ "content": "Data"
237
+ },
238
+ "cells": [
239
+ {
240
+ "content": "Live production data"
241
+ },
242
+ {
243
+ "content": "Mirror of prod (24h delay)"
244
+ },
245
+ {
246
+ "content": "Synthetic test data"
247
+ }
248
+ ]
249
+ },
250
+ {
251
+ "header": {
252
+ "content": "Rate Limit"
253
+ },
254
+ "cells": [
255
+ {
256
+ "content": "Per plan"
257
+ },
258
+ {
259
+ "content": "50% of plan"
260
+ },
261
+ {
262
+ "content": "Unlimited"
263
+ }
264
+ ]
265
+ }
266
+ ]
267
+ }
268
+ },
269
+ {
270
+ "name": "heading",
271
+ "props": {
272
+ "text": "Quick Start",
273
+ "level": 2
274
+ }
275
+ },
276
+ {
277
+ "name": "paragraph",
278
+ "props": {
279
+ "text": "Install the SDK, configure your credentials, and make your first API call:",
280
+ "font": {
281
+ "bold": true
282
+ }
283
+ }
284
+ },
285
+ {
286
+ "name": "paragraph",
287
+ "props": {
288
+ "text": "npm install @arcline/sdk",
289
+ "font": {
290
+ "family": "Consolas",
291
+ "size": 10
292
+ }
293
+ }
294
+ },
295
+ {
296
+ "name": "paragraph",
297
+ "props": {
298
+ "text": "import { ArclineClient } from '@arcline/sdk';\n\nconst client = new ArclineClient({\n clientId: process.env.ARCLINE_CLIENT_ID,\n clientSecret: process.env.ARCLINE_CLIENT_SECRET,\n});\n\nconst users = await client.users.list({ limit: 10 });\nconsole.log(users.data);",
299
+ "font": {
300
+ "family": "Consolas",
301
+ "size": 10
302
+ }
51
303
  }
52
304
  }
53
305
  ]
54
306
  },
55
307
  {
56
308
  "name": "section",
57
- "props": { "level": 1, "pageBreak": true },
309
+ "props": {
310
+ "level": 1,
311
+ "pageBreak": true,
312
+ "header": "linkToPrevious",
313
+ "footer": "linkToPrevious"
314
+ },
58
315
  "children": [
59
- { "name": "heading", "props": { "text": "Authentication", "level": 1 } },
60
- { "name": "paragraph", "props": { "text": "All API requests require a valid bearer token. Tokens are obtained via the OAuth 2.0 client credentials flow." } },
61
- { "name": "heading", "props": { "text": "Token Exchange", "level": 2 } },
62
- { "name": "paragraph", "props": { "text": "POST /oauth/token with your client_id and client_secret to receive an access token. Tokens expire after 3600 seconds. Include the token in subsequent requests via the Authorization header: Bearer <token>.", "font": { "family": "Courier New" } } },
63
- { "name": "heading", "props": { "text": "Available Scopes", "level": 2 } },
316
+ {
317
+ "name": "heading",
318
+ "props": {
319
+ "text": "Authentication",
320
+ "level": 1
321
+ }
322
+ },
323
+ {
324
+ "name": "paragraph",
325
+ "props": {
326
+ "text": "All API requests require a valid bearer token. Tokens are obtained via the OAuth 2.0 client credentials flow and expire after 3600 seconds (1 hour). The SDK handles token refresh automatically."
327
+ }
328
+ },
329
+ {
330
+ "name": "heading",
331
+ "props": {
332
+ "text": "Token Exchange",
333
+ "level": 2
334
+ }
335
+ },
336
+ {
337
+ "name": "paragraph",
338
+ "props": {
339
+ "text": "Request:",
340
+ "font": {
341
+ "bold": true
342
+ }
343
+ }
344
+ },
345
+ {
346
+ "name": "paragraph",
347
+ "props": {
348
+ "text": "POST https://auth.arcline.io/oauth/token\nContent-Type: application/x-www-form-urlencoded\n\ngrant_type=client_credentials\n&client_id=YOUR_CLIENT_ID\n&client_secret=YOUR_CLIENT_SECRET\n&scope=read:data write:data",
349
+ "font": {
350
+ "family": "Consolas",
351
+ "size": 10
352
+ }
353
+ }
354
+ },
355
+ {
356
+ "name": "paragraph",
357
+ "props": {
358
+ "text": "Response:",
359
+ "font": {
360
+ "bold": true
361
+ }
362
+ }
363
+ },
364
+ {
365
+ "name": "paragraph",
366
+ "props": {
367
+ "text": "{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIs...\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600,\n \"scope\": \"read:data write:data\"\n}",
368
+ "font": {
369
+ "family": "Consolas",
370
+ "size": 10
371
+ }
372
+ }
373
+ },
374
+ {
375
+ "name": "paragraph",
376
+ "props": {
377
+ "text": "Include the token in subsequent requests via the Authorization header:",
378
+ "font": {
379
+ "bold": true
380
+ }
381
+ }
382
+ },
383
+ {
384
+ "name": "paragraph",
385
+ "props": {
386
+ "text": "Authorization: Bearer eyJhbGciOiJSUzI1NiIs...",
387
+ "font": {
388
+ "family": "Consolas",
389
+ "size": 10
390
+ }
391
+ }
392
+ },
393
+ {
394
+ "name": "heading",
395
+ "props": {
396
+ "text": "Available Scopes",
397
+ "level": 2
398
+ }
399
+ },
64
400
  {
65
401
  "name": "table",
66
402
  "props": {
403
+ "headerCellDefaults": {
404
+ "font": {
405
+ "bold": true,
406
+ "size": 10
407
+ },
408
+ "padding": {
409
+ "top": 8,
410
+ "right": 10,
411
+ "bottom": 8,
412
+ "left": 10
413
+ }
414
+ },
415
+ "cellDefaults": {
416
+ "padding": {
417
+ "top": 5,
418
+ "right": 10,
419
+ "bottom": 5,
420
+ "left": 10
421
+ },
422
+ "verticalAlignment": "middle",
423
+ "font": {
424
+ "size": 10
425
+ }
426
+ },
427
+ "borderColor": "E2E8F0",
428
+ "borderSize": 1,
429
+ "hideBorders": {
430
+ "insideVertical": true
431
+ },
67
432
  "columns": [
68
- { "header": { "content": "Scope" }, "cells": [{ "content": "read:data" }, { "content": "write:data" }, { "content": "admin:users" }, { "content": "admin:config" }] },
69
- { "header": { "content": "Access Level" }, "cells": [{ "content": "Read-only" }, { "content": "Read/Write" }, { "content": "User management" }, { "content": "Configuration" }] },
70
- { "header": { "content": "Use Case" }, "cells": [{ "content": "Dashboards, reporting" }, { "content": "Data sync, imports" }, { "content": "Provisioning, SCIM" }, { "content": "Settings, webhooks" }] }
433
+ {
434
+ "header": {
435
+ "content": "Scope"
436
+ },
437
+ "cells": [
438
+ {
439
+ "content": "read:data"
440
+ },
441
+ {
442
+ "content": "write:data"
443
+ },
444
+ {
445
+ "content": "read:analytics"
446
+ },
447
+ {
448
+ "content": "admin:users"
449
+ },
450
+ {
451
+ "content": "admin:config"
452
+ },
453
+ {
454
+ "content": "webhooks:manage"
455
+ }
456
+ ]
457
+ },
458
+ {
459
+ "header": {
460
+ "content": "Access Level"
461
+ },
462
+ "cells": [
463
+ {
464
+ "content": "Read-only"
465
+ },
466
+ {
467
+ "content": "Read/Write"
468
+ },
469
+ {
470
+ "content": "Analytics queries"
471
+ },
472
+ {
473
+ "content": "User management"
474
+ },
475
+ {
476
+ "content": "Configuration"
477
+ },
478
+ {
479
+ "content": "Webhook CRUD"
480
+ }
481
+ ]
482
+ },
483
+ {
484
+ "header": {
485
+ "content": "Use Case"
486
+ },
487
+ "cells": [
488
+ {
489
+ "content": "Dashboards, reporting, data sync"
490
+ },
491
+ {
492
+ "content": "Data ingestion, imports, updates"
493
+ },
494
+ {
495
+ "content": "Custom reports, BI integration"
496
+ },
497
+ {
498
+ "content": "Provisioning, SSO/SCIM, RBAC"
499
+ },
500
+ {
501
+ "content": "Settings, feature flags, themes"
502
+ },
503
+ {
504
+ "content": "Event subscriptions, delivery mgmt"
505
+ }
506
+ ]
507
+ },
508
+ {
509
+ "header": {
510
+ "content": "Min Plan"
511
+ },
512
+ "cells": [
513
+ {
514
+ "content": "Free"
515
+ },
516
+ {
517
+ "content": "Pro"
518
+ },
519
+ {
520
+ "content": "Pro"
521
+ },
522
+ {
523
+ "content": "Enterprise"
524
+ },
525
+ {
526
+ "content": "Enterprise"
527
+ },
528
+ {
529
+ "content": "Pro"
530
+ }
531
+ ]
532
+ }
533
+ ]
534
+ }
535
+ },
536
+ {
537
+ "name": "heading",
538
+ "props": {
539
+ "text": "Token Security Best Practices",
540
+ "level": 2
541
+ }
542
+ },
543
+ {
544
+ "name": "list",
545
+ "props": {
546
+ "format": "bullet",
547
+ "items": [
548
+ "Never embed client secrets in client-side code or version control",
549
+ "Use environment variables or a secrets manager (AWS Secrets Manager, HashiCorp Vault)",
550
+ "Rotate client secrets every 90 days — the API supports two active secrets for zero-downtime rotation",
551
+ "Request only the scopes your integration needs (principle of least privilege)",
552
+ "Monitor the /oauth/audit endpoint for unauthorized token requests"
71
553
  ]
72
554
  }
73
555
  }
@@ -75,22 +557,43 @@
75
557
  },
76
558
  {
77
559
  "name": "section",
78
- "props": { "level": 1, "pageBreak": true },
560
+ "props": {
561
+ "level": 1,
562
+ "pageBreak": true,
563
+ "header": "linkToPrevious",
564
+ "footer": "linkToPrevious"
565
+ },
79
566
  "children": [
80
- { "name": "heading", "props": { "text": "API Reference", "level": 1 } },
81
- { "name": "heading", "props": { "text": "Resources", "level": 2 } },
567
+ {
568
+ "name": "heading",
569
+ "props": {
570
+ "text": "API Reference",
571
+ "level": 1
572
+ }
573
+ },
574
+ {
575
+ "name": "heading",
576
+ "props": {
577
+ "text": "Resource Endpoints",
578
+ "level": 2
579
+ }
580
+ },
82
581
  {
83
582
  "name": "columns",
84
- "props": { "columns": 2, "gap": 0.5 },
583
+ "props": {
584
+ "columns": 2,
585
+ "gap": 0.5
586
+ },
85
587
  "children": [
86
588
  {
87
589
  "name": "list",
88
590
  "props": {
89
591
  "format": "bullet",
90
592
  "items": [
91
- "/users — User management",
92
- "/teams — Team operations",
93
- "/projects — Project CRUD",
593
+ "/users — User management and profiles",
594
+ "/teams — Team operations and membership",
595
+ "/projects — Project CRUD and permissions",
596
+ "/pipelines — Data pipeline orchestration",
94
597
  "/webhooks — Event subscriptions"
95
598
  ]
96
599
  }
@@ -100,42 +603,356 @@
100
603
  "props": {
101
604
  "format": "bullet",
102
605
  "items": [
103
- "/events — Activity log",
104
- "/files — File storage",
105
- "/search — Full-text search",
106
- "/analytics — Usage metrics"
606
+ "/events — Activity log and audit trail",
607
+ "/files — File storage and versioning",
608
+ "/search — Full-text search across resources",
609
+ "/analytics — Usage metrics and custom queries",
610
+ "/exports — Scheduled data exports"
107
611
  ]
108
612
  }
109
613
  }
110
614
  ]
111
615
  },
112
- { "name": "heading", "props": { "text": "Rate Limits", "level": 2 } },
113
- { "name": "paragraph", "props": { "text": "API requests are rate-limited per token. Exceeding the limit returns HTTP 429. Use the Retry-After header to determine when to retry." } },
616
+ {
617
+ "name": "heading",
618
+ "props": {
619
+ "text": "Common Operations",
620
+ "level": 2
621
+ }
622
+ },
114
623
  {
115
624
  "name": "table",
116
625
  "props": {
626
+ "headerCellDefaults": {
627
+ "font": {
628
+ "bold": true,
629
+ "size": 10
630
+ },
631
+ "padding": {
632
+ "top": 8,
633
+ "right": 10,
634
+ "bottom": 8,
635
+ "left": 10
636
+ }
637
+ },
638
+ "cellDefaults": {
639
+ "padding": {
640
+ "top": 5,
641
+ "right": 10,
642
+ "bottom": 5,
643
+ "left": 10
644
+ },
645
+ "verticalAlignment": "middle",
646
+ "font": {
647
+ "size": 10
648
+ }
649
+ },
650
+ "borderColor": "E2E8F0",
651
+ "borderSize": 1,
652
+ "hideBorders": {
653
+ "insideVertical": true
654
+ },
117
655
  "columns": [
118
- { "header": { "content": "Plan" }, "cells": [{ "content": "Free" }, { "content": "Pro" }, { "content": "Enterprise" }] },
119
- { "header": { "content": "Requests/min" }, "cells": [{ "content": "60" }, { "content": "600" }, { "content": "6,000" }] },
120
- { "header": { "content": "Burst" }, "cells": [{ "content": "10" }, { "content": "100" }, { "content": "1,000" }] },
121
- { "header": { "content": "Concurrent" }, "cells": [{ "content": "5" }, { "content": "25" }, { "content": "100" }] }
122
- ],
123
- "headerCellDefaults": { "backgroundColor": "#1F2937", "color": "#FFFFFF" }
656
+ {
657
+ "header": {
658
+ "content": "Operation"
659
+ },
660
+ "cells": [
661
+ {
662
+ "content": "List resources"
663
+ },
664
+ {
665
+ "content": "Get single resource"
666
+ },
667
+ {
668
+ "content": "Create resource"
669
+ },
670
+ {
671
+ "content": "Update resource"
672
+ },
673
+ {
674
+ "content": "Delete resource"
675
+ },
676
+ {
677
+ "content": "Batch operations"
678
+ }
679
+ ]
680
+ },
681
+ {
682
+ "header": {
683
+ "content": "Method"
684
+ },
685
+ "cells": [
686
+ {
687
+ "content": "GET",
688
+ "font": {
689
+ "family": "Consolas"
690
+ }
691
+ },
692
+ {
693
+ "content": "GET",
694
+ "font": {
695
+ "family": "Consolas"
696
+ }
697
+ },
698
+ {
699
+ "content": "POST",
700
+ "font": {
701
+ "family": "Consolas"
702
+ }
703
+ },
704
+ {
705
+ "content": "PATCH",
706
+ "font": {
707
+ "family": "Consolas"
708
+ }
709
+ },
710
+ {
711
+ "content": "DELETE",
712
+ "font": {
713
+ "family": "Consolas"
714
+ }
715
+ },
716
+ {
717
+ "content": "POST",
718
+ "font": {
719
+ "family": "Consolas"
720
+ }
721
+ }
722
+ ]
723
+ },
724
+ {
725
+ "header": {
726
+ "content": "Path"
727
+ },
728
+ "cells": [
729
+ {
730
+ "content": "/{resource}",
731
+ "font": {
732
+ "family": "Consolas"
733
+ }
734
+ },
735
+ {
736
+ "content": "/{resource}/{id}",
737
+ "font": {
738
+ "family": "Consolas"
739
+ }
740
+ },
741
+ {
742
+ "content": "/{resource}",
743
+ "font": {
744
+ "family": "Consolas"
745
+ }
746
+ },
747
+ {
748
+ "content": "/{resource}/{id}",
749
+ "font": {
750
+ "family": "Consolas"
751
+ }
752
+ },
753
+ {
754
+ "content": "/{resource}/{id}",
755
+ "font": {
756
+ "family": "Consolas"
757
+ }
758
+ },
759
+ {
760
+ "content": "/{resource}/batch",
761
+ "font": {
762
+ "family": "Consolas"
763
+ }
764
+ }
765
+ ]
766
+ },
767
+ {
768
+ "header": {
769
+ "content": "Notes"
770
+ },
771
+ "cells": [
772
+ {
773
+ "content": "Supports ?limit, ?offset, ?sort, ?filter"
774
+ },
775
+ {
776
+ "content": "Returns 404 if not found"
777
+ },
778
+ {
779
+ "content": "Returns 201 with Location header"
780
+ },
781
+ {
782
+ "content": "Partial updates (merge semantics)"
783
+ },
784
+ {
785
+ "content": "Returns 204 No Content"
786
+ },
787
+ {
788
+ "content": "Up to 100 operations per request"
789
+ }
790
+ ]
791
+ }
792
+ ]
124
793
  }
125
794
  },
126
- { "name": "heading", "props": { "text": "Error Handling", "level": 2 } },
127
- { "name": "paragraph", "props": { "text": "The API uses standard HTTP status codes. All error responses include a JSON body with code, message, and request_id fields. Common errors:" } },
128
795
  {
129
- "name": "list",
796
+ "name": "heading",
130
797
  "props": {
131
- "format": "bullet",
132
- "items": [
133
- "400 Bad Request — Invalid parameters or malformed JSON",
134
- "401 Unauthorized — Missing or expired token",
135
- "403 Forbidden — Insufficient scope for the requested operation",
136
- "404 Not Found — Resource does not exist",
137
- "429 Too Many Requests — Rate limit exceeded",
138
- "500 Internal Server Error Unexpected server failure (include request_id in support tickets)"
798
+ "text": "Pagination",
799
+ "level": 2
800
+ }
801
+ },
802
+ {
803
+ "name": "paragraph",
804
+ "props": {
805
+ "text": "All list endpoints support cursor-based pagination. The response includes a meta object with pagination details:",
806
+ "font": {
807
+ "bold": true
808
+ }
809
+ }
810
+ },
811
+ {
812
+ "name": "paragraph",
813
+ "props": {
814
+ "text": "{\n \"data\": [...],\n \"meta\": {\n \"total\": 1247,\n \"limit\": 25,\n \"has_more\": true,\n \"next_cursor\": \"eyJpZCI6MTI0N30=\"\n }\n}",
815
+ "font": {
816
+ "family": "Consolas",
817
+ "size": 10
818
+ }
819
+ }
820
+ },
821
+ {
822
+ "name": "paragraph",
823
+ "props": {
824
+ "text": "Pass the next_cursor value as the ?cursor query parameter to fetch the next page. Maximum limit is 100 items per request.",
825
+ "font": {
826
+ "color": "textSecondary"
827
+ }
828
+ }
829
+ },
830
+ {
831
+ "name": "heading",
832
+ "props": {
833
+ "text": "Rate Limits",
834
+ "level": 2
835
+ }
836
+ },
837
+ {
838
+ "name": "paragraph",
839
+ "props": {
840
+ "text": "API requests are rate-limited per token. Exceeding the limit returns HTTP 429 Too Many Requests. Use the Retry-After header (in seconds) to determine when to retry. The SDK handles retries with exponential backoff automatically."
841
+ }
842
+ },
843
+ {
844
+ "name": "table",
845
+ "props": {
846
+ "headerCellDefaults": {
847
+ "font": {
848
+ "bold": true,
849
+ "size": 10
850
+ },
851
+ "padding": {
852
+ "top": 8,
853
+ "right": 10,
854
+ "bottom": 8,
855
+ "left": 10
856
+ }
857
+ },
858
+ "cellDefaults": {
859
+ "padding": {
860
+ "top": 5,
861
+ "right": 10,
862
+ "bottom": 5,
863
+ "left": 10
864
+ },
865
+ "verticalAlignment": "middle",
866
+ "font": {
867
+ "size": 10
868
+ }
869
+ },
870
+ "borderColor": "E2E8F0",
871
+ "borderSize": 1,
872
+ "hideBorders": {
873
+ "insideVertical": true
874
+ },
875
+ "columns": [
876
+ {
877
+ "header": {
878
+ "content": "Plan"
879
+ },
880
+ "cells": [
881
+ {
882
+ "content": "Free"
883
+ },
884
+ {
885
+ "content": "Pro"
886
+ },
887
+ {
888
+ "content": "Enterprise"
889
+ }
890
+ ]
891
+ },
892
+ {
893
+ "header": {
894
+ "content": "Requests/min"
895
+ },
896
+ "cells": [
897
+ {
898
+ "content": "60"
899
+ },
900
+ {
901
+ "content": "600"
902
+ },
903
+ {
904
+ "content": "6,000"
905
+ }
906
+ ]
907
+ },
908
+ {
909
+ "header": {
910
+ "content": "Burst"
911
+ },
912
+ "cells": [
913
+ {
914
+ "content": "10"
915
+ },
916
+ {
917
+ "content": "100"
918
+ },
919
+ {
920
+ "content": "1,000"
921
+ }
922
+ ]
923
+ },
924
+ {
925
+ "header": {
926
+ "content": "Concurrent"
927
+ },
928
+ "cells": [
929
+ {
930
+ "content": "5"
931
+ },
932
+ {
933
+ "content": "25"
934
+ },
935
+ {
936
+ "content": "100"
937
+ }
938
+ ]
939
+ },
940
+ {
941
+ "header": {
942
+ "content": "Daily Quota"
943
+ },
944
+ "cells": [
945
+ {
946
+ "content": "10,000"
947
+ },
948
+ {
949
+ "content": "500,000"
950
+ },
951
+ {
952
+ "content": "Unlimited"
953
+ }
954
+ ]
955
+ }
139
956
  ]
140
957
  }
141
958
  }
@@ -143,30 +960,826 @@
143
960
  },
144
961
  {
145
962
  "name": "section",
146
- "props": { "level": 1, "pageBreak": true },
963
+ "props": {
964
+ "level": 1,
965
+ "pageBreak": true,
966
+ "header": "linkToPrevious",
967
+ "footer": "linkToPrevious"
968
+ },
147
969
  "children": [
148
- { "name": "heading", "props": { "text": "Webhooks", "level": 1 } },
149
- { "name": "paragraph", "props": { "text": "Webhooks deliver real-time event notifications to your endpoint via HTTP POST. Configure webhooks in the dashboard or via the /webhooks API. All payloads are signed with HMAC-SHA256." } },
150
- { "name": "heading", "props": { "text": "Supported Events", "level": 2 } },
970
+ {
971
+ "name": "heading",
972
+ "props": {
973
+ "text": "Webhooks",
974
+ "level": 1
975
+ }
976
+ },
977
+ {
978
+ "name": "paragraph",
979
+ "props": {
980
+ "text": "Webhooks deliver real-time event notifications to your endpoint via HTTP POST. Configure webhooks in the dashboard (Settings > Webhooks) or via the /webhooks API. All payloads are signed with HMAC-SHA256 using your webhook secret for verification."
981
+ }
982
+ },
983
+ {
984
+ "name": "heading",
985
+ "props": {
986
+ "text": "Supported Events",
987
+ "level": 2
988
+ }
989
+ },
151
990
  {
152
991
  "name": "columns",
153
- "props": { "columns": 2 },
992
+ "props": {
993
+ "columns": 2
994
+ },
154
995
  "children": [
155
996
  {
156
997
  "name": "table",
157
998
  "props": {
999
+ "headerCellDefaults": {
1000
+ "font": {
1001
+ "bold": true,
1002
+ "size": 9
1003
+ },
1004
+ "padding": {
1005
+ "top": 6,
1006
+ "right": 8,
1007
+ "bottom": 6,
1008
+ "left": 8
1009
+ }
1010
+ },
1011
+ "cellDefaults": {
1012
+ "padding": {
1013
+ "top": 4,
1014
+ "right": 8,
1015
+ "bottom": 4,
1016
+ "left": 8
1017
+ },
1018
+ "verticalAlignment": "middle",
1019
+ "font": {
1020
+ "size": 9
1021
+ }
1022
+ },
1023
+ "borderColor": "E2E8F0",
1024
+ "borderSize": 1,
1025
+ "hideBorders": {
1026
+ "insideVertical": true
1027
+ },
158
1028
  "columns": [
159
- { "header": { "content": "Event" }, "cells": [{ "content": "user.created" }, { "content": "user.updated" }, { "content": "project.created" }, { "content": "project.archived" }] },
160
- { "header": { "content": "Trigger" }, "cells": [{ "content": "New user signup" }, { "content": "Profile change" }, { "content": "New project" }, { "content": "Project archived" }] }
1029
+ {
1030
+ "header": {
1031
+ "content": "Event"
1032
+ },
1033
+ "cells": [
1034
+ {
1035
+ "content": "user.created"
1036
+ },
1037
+ {
1038
+ "content": "user.updated"
1039
+ },
1040
+ {
1041
+ "content": "user.deleted"
1042
+ },
1043
+ {
1044
+ "content": "project.created"
1045
+ },
1046
+ {
1047
+ "content": "project.archived"
1048
+ },
1049
+ {
1050
+ "content": "pipeline.completed"
1051
+ }
1052
+ ]
1053
+ },
1054
+ {
1055
+ "header": {
1056
+ "content": "Trigger"
1057
+ },
1058
+ "cells": [
1059
+ {
1060
+ "content": "New user signup or SSO provision"
1061
+ },
1062
+ {
1063
+ "content": "Profile or permission change"
1064
+ },
1065
+ {
1066
+ "content": "Account deactivation"
1067
+ },
1068
+ {
1069
+ "content": "New project created"
1070
+ },
1071
+ {
1072
+ "content": "Project archived by owner"
1073
+ },
1074
+ {
1075
+ "content": "Pipeline run finished"
1076
+ }
1077
+ ]
1078
+ }
161
1079
  ]
162
1080
  }
163
1081
  },
164
1082
  {
165
1083
  "name": "table",
166
1084
  "props": {
1085
+ "headerCellDefaults": {
1086
+ "font": {
1087
+ "bold": true,
1088
+ "size": 9
1089
+ },
1090
+ "padding": {
1091
+ "top": 6,
1092
+ "right": 8,
1093
+ "bottom": 6,
1094
+ "left": 8
1095
+ }
1096
+ },
1097
+ "cellDefaults": {
1098
+ "padding": {
1099
+ "top": 4,
1100
+ "right": 8,
1101
+ "bottom": 4,
1102
+ "left": 8
1103
+ },
1104
+ "verticalAlignment": "middle",
1105
+ "font": {
1106
+ "size": 9
1107
+ }
1108
+ },
1109
+ "borderColor": "E2E8F0",
1110
+ "borderSize": 1,
1111
+ "hideBorders": {
1112
+ "insideVertical": true
1113
+ },
167
1114
  "columns": [
168
- { "header": { "content": "Event" }, "cells": [{ "content": "file.uploaded" }, { "content": "file.deleted" }, { "content": "team.member_added" }, { "content": "billing.invoice" }] },
169
- { "header": { "content": "Trigger" }, "cells": [{ "content": "New file" }, { "content": "File removed" }, { "content": "User joins team" }, { "content": "Invoice generated" }] }
1115
+ {
1116
+ "header": {
1117
+ "content": "Event"
1118
+ },
1119
+ "cells": [
1120
+ {
1121
+ "content": "pipeline.failed"
1122
+ },
1123
+ {
1124
+ "content": "file.uploaded"
1125
+ },
1126
+ {
1127
+ "content": "file.deleted"
1128
+ },
1129
+ {
1130
+ "content": "team.member_added"
1131
+ },
1132
+ {
1133
+ "content": "billing.invoice"
1134
+ },
1135
+ {
1136
+ "content": "export.ready"
1137
+ }
1138
+ ]
1139
+ },
1140
+ {
1141
+ "header": {
1142
+ "content": "Trigger"
1143
+ },
1144
+ "cells": [
1145
+ {
1146
+ "content": "Pipeline run errored"
1147
+ },
1148
+ {
1149
+ "content": "New file uploaded"
1150
+ },
1151
+ {
1152
+ "content": "File permanently removed"
1153
+ },
1154
+ {
1155
+ "content": "User added to team"
1156
+ },
1157
+ {
1158
+ "content": "Monthly invoice generated"
1159
+ },
1160
+ {
1161
+ "content": "Scheduled export completed"
1162
+ }
1163
+ ]
1164
+ }
1165
+ ]
1166
+ }
1167
+ }
1168
+ ]
1169
+ },
1170
+ {
1171
+ "name": "heading",
1172
+ "props": {
1173
+ "text": "Payload Structure",
1174
+ "level": 2
1175
+ }
1176
+ },
1177
+ {
1178
+ "name": "paragraph",
1179
+ "props": {
1180
+ "text": "Every webhook delivery includes the following envelope:",
1181
+ "font": {
1182
+ "bold": true
1183
+ }
1184
+ }
1185
+ },
1186
+ {
1187
+ "name": "paragraph",
1188
+ "props": {
1189
+ "text": "{\n \"id\": \"evt_a1b2c3d4e5\",\n \"type\": \"user.created\",\n \"created_at\": \"2026-04-01T14:30:00Z\",\n \"data\": { ... },\n \"metadata\": {\n \"delivery_id\": \"dlv_x9y8z7\",\n \"attempt\": 1,\n \"webhook_id\": \"whk_m4n5o6\"\n }\n}",
1190
+ "font": {
1191
+ "family": "Consolas",
1192
+ "size": 10
1193
+ }
1194
+ }
1195
+ },
1196
+ {
1197
+ "name": "heading",
1198
+ "props": {
1199
+ "text": "Signature Verification",
1200
+ "level": 2
1201
+ }
1202
+ },
1203
+ {
1204
+ "name": "paragraph",
1205
+ "props": {
1206
+ "text": "Verify the X-Arcline-Signature header to ensure the payload was sent by Arcline and has not been tampered with:",
1207
+ "font": {
1208
+ "bold": true
1209
+ }
1210
+ }
1211
+ },
1212
+ {
1213
+ "name": "paragraph",
1214
+ "props": {
1215
+ "text": "import crypto from 'crypto';\n\nfunction verifySignature(payload, signature, secret) {\n const expected = crypto\n .createHmac('sha256', secret)\n .update(payload)\n .digest('hex');\n return crypto.timingSafeEqual(\n Buffer.from(signature),\n Buffer.from(expected)\n );\n}",
1216
+ "font": {
1217
+ "family": "Consolas",
1218
+ "size": 10
1219
+ }
1220
+ }
1221
+ },
1222
+ {
1223
+ "name": "heading",
1224
+ "props": {
1225
+ "text": "Retry Policy",
1226
+ "level": 2
1227
+ }
1228
+ },
1229
+ {
1230
+ "name": "paragraph",
1231
+ "props": {
1232
+ "text": "Failed deliveries (non-2xx response or timeout after 30 seconds) are retried with exponential backoff:"
1233
+ }
1234
+ },
1235
+ {
1236
+ "name": "table",
1237
+ "props": {
1238
+ "headerCellDefaults": {
1239
+ "font": {
1240
+ "bold": true,
1241
+ "size": 10
1242
+ },
1243
+ "padding": {
1244
+ "top": 8,
1245
+ "right": 10,
1246
+ "bottom": 8,
1247
+ "left": 10
1248
+ }
1249
+ },
1250
+ "cellDefaults": {
1251
+ "padding": {
1252
+ "top": 5,
1253
+ "right": 10,
1254
+ "bottom": 5,
1255
+ "left": 10
1256
+ },
1257
+ "verticalAlignment": "middle",
1258
+ "font": {
1259
+ "size": 10
1260
+ }
1261
+ },
1262
+ "borderColor": "E2E8F0",
1263
+ "borderSize": 1,
1264
+ "hideBorders": {
1265
+ "insideVertical": true
1266
+ },
1267
+ "columns": [
1268
+ {
1269
+ "header": {
1270
+ "content": "Attempt"
1271
+ },
1272
+ "cells": [
1273
+ {
1274
+ "content": "1st retry"
1275
+ },
1276
+ {
1277
+ "content": "2nd retry"
1278
+ },
1279
+ {
1280
+ "content": "3rd retry"
1281
+ },
1282
+ {
1283
+ "content": "4th retry"
1284
+ },
1285
+ {
1286
+ "content": "5th retry (final)"
1287
+ }
1288
+ ]
1289
+ },
1290
+ {
1291
+ "header": {
1292
+ "content": "Delay"
1293
+ },
1294
+ "cells": [
1295
+ {
1296
+ "content": "1 minute"
1297
+ },
1298
+ {
1299
+ "content": "5 minutes"
1300
+ },
1301
+ {
1302
+ "content": "30 minutes"
1303
+ },
1304
+ {
1305
+ "content": "2 hours"
1306
+ },
1307
+ {
1308
+ "content": "24 hours"
1309
+ }
1310
+ ]
1311
+ },
1312
+ {
1313
+ "header": {
1314
+ "content": "Cumulative"
1315
+ },
1316
+ "cells": [
1317
+ {
1318
+ "content": "~1 min"
1319
+ },
1320
+ {
1321
+ "content": "~6 min"
1322
+ },
1323
+ {
1324
+ "content": "~36 min"
1325
+ },
1326
+ {
1327
+ "content": "~2.5 hours"
1328
+ },
1329
+ {
1330
+ "content": "~26.5 hours"
1331
+ }
1332
+ ]
1333
+ }
1334
+ ]
1335
+ }
1336
+ },
1337
+ {
1338
+ "name": "paragraph",
1339
+ "props": {
1340
+ "text": "After 5 failed attempts, the event is marked as failed and visible in the dashboard. Webhooks with > 95% failure rate over 48 hours are automatically disabled with an email notification to the account owner."
1341
+ }
1342
+ }
1343
+ ]
1344
+ },
1345
+ {
1346
+ "name": "section",
1347
+ "props": {
1348
+ "level": 1,
1349
+ "pageBreak": true,
1350
+ "header": "linkToPrevious",
1351
+ "footer": "linkToPrevious"
1352
+ },
1353
+ "children": [
1354
+ {
1355
+ "name": "heading",
1356
+ "props": {
1357
+ "text": "Error Handling",
1358
+ "level": 1
1359
+ }
1360
+ },
1361
+ {
1362
+ "name": "paragraph",
1363
+ "props": {
1364
+ "text": "The API uses standard HTTP status codes. All error responses include a JSON body with code, message, request_id, and optional details fields."
1365
+ }
1366
+ },
1367
+ {
1368
+ "name": "heading",
1369
+ "props": {
1370
+ "text": "Error Response Format",
1371
+ "level": 2
1372
+ }
1373
+ },
1374
+ {
1375
+ "name": "paragraph",
1376
+ "props": {
1377
+ "text": "{\n \"error\": {\n \"code\": \"validation_error\",\n \"message\": \"Invalid request parameters\",\n \"request_id\": \"req_abc123\",\n \"details\": [\n { \"field\": \"email\", \"message\": \"must be a valid email address\" }\n ]\n }\n}",
1378
+ "font": {
1379
+ "family": "Consolas",
1380
+ "size": 10
1381
+ }
1382
+ }
1383
+ },
1384
+ {
1385
+ "name": "heading",
1386
+ "props": {
1387
+ "text": "Status Code Reference",
1388
+ "level": 2
1389
+ }
1390
+ },
1391
+ {
1392
+ "name": "table",
1393
+ "props": {
1394
+ "headerCellDefaults": {
1395
+ "font": {
1396
+ "bold": true,
1397
+ "size": 10
1398
+ },
1399
+ "padding": {
1400
+ "top": 8,
1401
+ "right": 10,
1402
+ "bottom": 8,
1403
+ "left": 10
1404
+ }
1405
+ },
1406
+ "cellDefaults": {
1407
+ "padding": {
1408
+ "top": 5,
1409
+ "right": 10,
1410
+ "bottom": 5,
1411
+ "left": 10
1412
+ },
1413
+ "verticalAlignment": "middle",
1414
+ "font": {
1415
+ "size": 10
1416
+ }
1417
+ },
1418
+ "borderColor": "E2E8F0",
1419
+ "borderSize": 1,
1420
+ "hideBorders": {
1421
+ "insideVertical": true
1422
+ },
1423
+ "columns": [
1424
+ {
1425
+ "header": {
1426
+ "content": "Code"
1427
+ },
1428
+ "cells": [
1429
+ {
1430
+ "content": "400"
1431
+ },
1432
+ {
1433
+ "content": "401"
1434
+ },
1435
+ {
1436
+ "content": "403"
1437
+ },
1438
+ {
1439
+ "content": "404"
1440
+ },
1441
+ {
1442
+ "content": "409"
1443
+ },
1444
+ {
1445
+ "content": "422"
1446
+ },
1447
+ {
1448
+ "content": "429"
1449
+ },
1450
+ {
1451
+ "content": "500"
1452
+ },
1453
+ {
1454
+ "content": "503"
1455
+ }
1456
+ ]
1457
+ },
1458
+ {
1459
+ "header": {
1460
+ "content": "Meaning"
1461
+ },
1462
+ "cells": [
1463
+ {
1464
+ "content": "Bad Request"
1465
+ },
1466
+ {
1467
+ "content": "Unauthorized"
1468
+ },
1469
+ {
1470
+ "content": "Forbidden"
1471
+ },
1472
+ {
1473
+ "content": "Not Found"
1474
+ },
1475
+ {
1476
+ "content": "Conflict"
1477
+ },
1478
+ {
1479
+ "content": "Unprocessable Entity"
1480
+ },
1481
+ {
1482
+ "content": "Rate Limited"
1483
+ },
1484
+ {
1485
+ "content": "Internal Error"
1486
+ },
1487
+ {
1488
+ "content": "Service Unavailable"
1489
+ }
1490
+ ]
1491
+ },
1492
+ {
1493
+ "header": {
1494
+ "content": "Common Cause"
1495
+ },
1496
+ "cells": [
1497
+ {
1498
+ "content": "Malformed JSON or invalid query parameters"
1499
+ },
1500
+ {
1501
+ "content": "Missing or expired bearer token"
1502
+ },
1503
+ {
1504
+ "content": "Insufficient scope for the operation"
1505
+ },
1506
+ {
1507
+ "content": "Resource does not exist or was deleted"
1508
+ },
1509
+ {
1510
+ "content": "Duplicate resource or concurrent modification"
1511
+ },
1512
+ {
1513
+ "content": "Valid JSON but semantic validation failed"
1514
+ },
1515
+ {
1516
+ "content": "Rate limit exceeded — check Retry-After header"
1517
+ },
1518
+ {
1519
+ "content": "Unexpected server error — include request_id in support tickets"
1520
+ },
1521
+ {
1522
+ "content": "Temporary outage — retry with backoff"
1523
+ }
1524
+ ]
1525
+ },
1526
+ {
1527
+ "header": {
1528
+ "content": "Retryable?"
1529
+ },
1530
+ "cells": [
1531
+ {
1532
+ "content": "No"
1533
+ },
1534
+ {
1535
+ "content": "No (refresh token)"
1536
+ },
1537
+ {
1538
+ "content": "No"
1539
+ },
1540
+ {
1541
+ "content": "No"
1542
+ },
1543
+ {
1544
+ "content": "Maybe"
1545
+ },
1546
+ {
1547
+ "content": "No (fix input)"
1548
+ },
1549
+ {
1550
+ "content": "Yes"
1551
+ },
1552
+ {
1553
+ "content": "Yes"
1554
+ },
1555
+ {
1556
+ "content": "Yes"
1557
+ }
1558
+ ]
1559
+ }
1560
+ ]
1561
+ }
1562
+ },
1563
+ {
1564
+ "name": "heading",
1565
+ "props": {
1566
+ "text": "Idempotency",
1567
+ "level": 2
1568
+ }
1569
+ },
1570
+ {
1571
+ "name": "paragraph",
1572
+ "props": {
1573
+ "text": "For POST and PATCH requests, include an Idempotency-Key header to safely retry failed requests without creating duplicates:",
1574
+ "font": {
1575
+ "bold": true
1576
+ }
1577
+ }
1578
+ },
1579
+ {
1580
+ "name": "paragraph",
1581
+ "props": {
1582
+ "text": "POST /v3/users\nIdempotency-Key: idk_unique-request-id-12345\nContent-Type: application/json\n\n{ \"email\": \"jane@example.com\", \"name\": \"Jane Doe\" }",
1583
+ "font": {
1584
+ "family": "Consolas",
1585
+ "size": 10
1586
+ }
1587
+ }
1588
+ },
1589
+ {
1590
+ "name": "paragraph",
1591
+ "props": {
1592
+ "text": "Idempotency keys are valid for 24 hours. Replayed requests within this window return the original response without executing the operation again."
1593
+ }
1594
+ }
1595
+ ]
1596
+ },
1597
+ {
1598
+ "name": "section",
1599
+ "props": {
1600
+ "level": 1,
1601
+ "pageBreak": true,
1602
+ "header": "linkToPrevious",
1603
+ "footer": "linkToPrevious"
1604
+ },
1605
+ "children": [
1606
+ {
1607
+ "name": "heading",
1608
+ "props": {
1609
+ "text": "Troubleshooting",
1610
+ "level": 1
1611
+ }
1612
+ },
1613
+ {
1614
+ "name": "heading",
1615
+ "props": {
1616
+ "text": "Common Issues",
1617
+ "level": 2
1618
+ }
1619
+ },
1620
+ {
1621
+ "name": "table",
1622
+ "props": {
1623
+ "headerCellDefaults": {
1624
+ "font": {
1625
+ "bold": true,
1626
+ "size": 10
1627
+ },
1628
+ "padding": {
1629
+ "top": 8,
1630
+ "right": 10,
1631
+ "bottom": 8,
1632
+ "left": 10
1633
+ }
1634
+ },
1635
+ "cellDefaults": {
1636
+ "padding": {
1637
+ "top": 5,
1638
+ "right": 10,
1639
+ "bottom": 5,
1640
+ "left": 10
1641
+ },
1642
+ "verticalAlignment": "middle",
1643
+ "font": {
1644
+ "size": 10
1645
+ }
1646
+ },
1647
+ "borderColor": "E2E8F0",
1648
+ "borderSize": 1,
1649
+ "hideBorders": {
1650
+ "insideVertical": true
1651
+ },
1652
+ "columns": [
1653
+ {
1654
+ "header": {
1655
+ "content": "Symptom"
1656
+ },
1657
+ "cells": [
1658
+ {
1659
+ "content": "401 on every request"
1660
+ },
1661
+ {
1662
+ "content": "Webhook not firing"
1663
+ },
1664
+ {
1665
+ "content": "Slow list queries"
1666
+ },
1667
+ {
1668
+ "content": "Missing data in responses"
1669
+ },
1670
+ {
1671
+ "content": "CORS errors in browser"
1672
+ }
1673
+ ]
1674
+ },
1675
+ {
1676
+ "header": {
1677
+ "content": "Likely Cause"
1678
+ },
1679
+ "cells": [
1680
+ {
1681
+ "content": "Expired or malformed token"
1682
+ },
1683
+ {
1684
+ "content": "Endpoint unreachable or auto-disabled"
1685
+ },
1686
+ {
1687
+ "content": "Missing index on filter field"
1688
+ },
1689
+ {
1690
+ "content": "Insufficient scope on token"
1691
+ },
1692
+ {
1693
+ "content": "Origin not in allowed list"
1694
+ }
1695
+ ]
1696
+ },
1697
+ {
1698
+ "header": {
1699
+ "content": "Resolution"
1700
+ },
1701
+ "cells": [
1702
+ {
1703
+ "content": "Refresh token; verify client_id/secret; check clock skew < 60s"
1704
+ },
1705
+ {
1706
+ "content": "Check dashboard > Webhooks > Delivery Log; re-enable if disabled"
1707
+ },
1708
+ {
1709
+ "content": "Use ?limit to reduce page size; add ?fields to select specific columns"
1710
+ },
1711
+ {
1712
+ "content": "Re-issue token with required scopes; check admin:users for user data"
1713
+ },
1714
+ {
1715
+ "content": "Add your domain in Settings > API Keys > Allowed Origins"
1716
+ }
1717
+ ]
1718
+ }
1719
+ ]
1720
+ }
1721
+ },
1722
+ {
1723
+ "name": "heading",
1724
+ "props": {
1725
+ "text": "Debug Mode",
1726
+ "level": 2
1727
+ }
1728
+ },
1729
+ {
1730
+ "name": "paragraph",
1731
+ "props": {
1732
+ "text": "Enable verbose logging in the SDK to inspect request/response details:",
1733
+ "font": {
1734
+ "bold": true
1735
+ }
1736
+ }
1737
+ },
1738
+ {
1739
+ "name": "paragraph",
1740
+ "props": {
1741
+ "text": "const client = new ArclineClient({\n clientId: process.env.ARCLINE_CLIENT_ID,\n clientSecret: process.env.ARCLINE_CLIENT_SECRET,\n debug: true, // Logs full request/response to stdout\n timeout: 30000, // 30s timeout (default: 15s)\n});",
1742
+ "font": {
1743
+ "family": "Consolas",
1744
+ "size": 10
1745
+ }
1746
+ }
1747
+ },
1748
+ {
1749
+ "name": "heading",
1750
+ "props": {
1751
+ "text": "Support & Resources",
1752
+ "level": 2
1753
+ }
1754
+ },
1755
+ {
1756
+ "name": "columns",
1757
+ "props": {
1758
+ "columns": 2,
1759
+ "gap": 0.5
1760
+ },
1761
+ "children": [
1762
+ {
1763
+ "name": "list",
1764
+ "props": {
1765
+ "format": "bullet",
1766
+ "items": [
1767
+ "API Status: status.arcline.io",
1768
+ "Developer Docs: docs.arcline.io",
1769
+ "SDK Source: github.com/arcline/sdk",
1770
+ "Community: community.arcline.io"
1771
+ ]
1772
+ }
1773
+ },
1774
+ {
1775
+ "name": "list",
1776
+ "props": {
1777
+ "format": "bullet",
1778
+ "items": [
1779
+ "Email: support@arcline.io",
1780
+ "Enterprise Support: 24/7 Slack channel",
1781
+ "Office Hours: Thursdays 2-3pm PT",
1782
+ "Security: security@arcline.io (PGP key on docs)"
170
1783
  ]
171
1784
  }
172
1785
  }