pdfdancer-client-typescript 1.0.12 → 1.0.13

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 (65) hide show
  1. package/.github/workflows/ci.yml +1 -1
  2. package/README.md +1 -1
  3. package/dist/__tests__/e2e/pdf-assertions.d.ts +1 -0
  4. package/dist/__tests__/e2e/pdf-assertions.d.ts.map +1 -1
  5. package/dist/__tests__/e2e/pdf-assertions.js +9 -3
  6. package/dist/__tests__/e2e/pdf-assertions.js.map +1 -1
  7. package/dist/fingerprint.d.ts +12 -0
  8. package/dist/fingerprint.d.ts.map +1 -0
  9. package/dist/fingerprint.js +196 -0
  10. package/dist/fingerprint.js.map +1 -0
  11. package/dist/image-builder.d.ts +4 -2
  12. package/dist/image-builder.d.ts.map +1 -1
  13. package/dist/image-builder.js +12 -3
  14. package/dist/image-builder.js.map +1 -1
  15. package/dist/index.d.ts +2 -1
  16. package/dist/index.d.ts.map +1 -1
  17. package/dist/index.js +7 -1
  18. package/dist/index.js.map +1 -1
  19. package/dist/models.d.ts +75 -8
  20. package/dist/models.d.ts.map +1 -1
  21. package/dist/models.js +179 -21
  22. package/dist/models.js.map +1 -1
  23. package/dist/page-builder.d.ts +24 -0
  24. package/dist/page-builder.d.ts.map +1 -0
  25. package/dist/page-builder.js +107 -0
  26. package/dist/page-builder.js.map +1 -0
  27. package/dist/paragraph-builder.d.ts +48 -54
  28. package/dist/paragraph-builder.d.ts.map +1 -1
  29. package/dist/paragraph-builder.js +408 -135
  30. package/dist/paragraph-builder.js.map +1 -1
  31. package/dist/pdfdancer_v1.d.ts +90 -9
  32. package/dist/pdfdancer_v1.d.ts.map +1 -1
  33. package/dist/pdfdancer_v1.js +535 -50
  34. package/dist/pdfdancer_v1.js.map +1 -1
  35. package/dist/types.d.ts +24 -3
  36. package/dist/types.d.ts.map +1 -1
  37. package/dist/types.js +117 -2
  38. package/dist/types.js.map +1 -1
  39. package/docs/openapi.yml +2076 -0
  40. package/fixtures/Showcase.pdf +0 -0
  41. package/package.json +1 -1
  42. package/src/__tests__/e2e/acroform.test.ts +5 -5
  43. package/src/__tests__/e2e/context-manager-showcase.test.ts +267 -0
  44. package/src/__tests__/e2e/form_x_object.test.ts +1 -1
  45. package/src/__tests__/e2e/image-showcase.test.ts +133 -0
  46. package/src/__tests__/e2e/image.test.ts +1 -1
  47. package/src/__tests__/e2e/line-showcase.test.ts +118 -0
  48. package/src/__tests__/e2e/line.test.ts +1 -16
  49. package/src/__tests__/e2e/page-showcase.test.ts +154 -0
  50. package/src/__tests__/e2e/paragraph-showcase.test.ts +523 -0
  51. package/src/__tests__/e2e/paragraph.test.ts +8 -8
  52. package/src/__tests__/e2e/pdf-assertions.ts +10 -3
  53. package/src/__tests__/e2e/pdfdancer-showcase.test.ts +40 -0
  54. package/src/__tests__/e2e/snapshot-showcase.test.ts +158 -0
  55. package/src/__tests__/e2e/snapshot.test.ts +296 -0
  56. package/src/__tests__/fingerprint.test.ts +36 -0
  57. package/src/fingerprint.ts +169 -0
  58. package/src/image-builder.ts +13 -6
  59. package/src/index.ts +6 -1
  60. package/src/models.ts +208 -24
  61. package/src/page-builder.ts +130 -0
  62. package/src/paragraph-builder.ts +517 -159
  63. package/src/pdfdancer_v1.ts +630 -51
  64. package/src/types.ts +145 -2
  65. package/update-api-spec.sh +3 -0
@@ -0,0 +1,2076 @@
1
+ openapi: 3.0.1
2
+ info:
3
+ title: development
4
+ version: "0.0"
5
+ paths:
6
+ /config:
7
+ get:
8
+ operationId: findFont
9
+ parameters:
10
+ - name: v
11
+ in: query
12
+ description: API version
13
+ schema:
14
+ type: string
15
+ - name: api-version
16
+ in: query
17
+ description: API version
18
+ schema:
19
+ type: string
20
+ - name: X-API-VERSION
21
+ in: header
22
+ description: API version
23
+ schema:
24
+ type: string
25
+ - name: Accept-Version
26
+ in: header
27
+ description: API version
28
+ schema:
29
+ type: string
30
+ responses:
31
+ "200":
32
+ description: findFont 200 response
33
+ content:
34
+ application/json:
35
+ schema:
36
+ type: object
37
+ additionalProperties:
38
+ type: object
39
+ /font/find:
40
+ get:
41
+ operationId: findFont_1
42
+ parameters:
43
+ - name: X-Session-Id
44
+ in: header
45
+ required: true
46
+ schema:
47
+ type: string
48
+ - name: fontName
49
+ in: query
50
+ required: true
51
+ explode: false
52
+ schema:
53
+ type: string
54
+ - name: v
55
+ in: query
56
+ description: API version
57
+ schema:
58
+ type: string
59
+ - name: api-version
60
+ in: query
61
+ description: API version
62
+ schema:
63
+ type: string
64
+ - name: X-API-VERSION
65
+ in: header
66
+ description: API version
67
+ schema:
68
+ type: string
69
+ - name: Accept-Version
70
+ in: header
71
+ description: API version
72
+ schema:
73
+ type: string
74
+ responses:
75
+ "200":
76
+ description: findFont_1 200 response
77
+ content:
78
+ application/json:
79
+ schema:
80
+ type: array
81
+ items:
82
+ type: string
83
+ /font/get/{fontName}:
84
+ get:
85
+ operationId: getFont
86
+ parameters:
87
+ - name: X-Session-Id
88
+ in: header
89
+ required: true
90
+ schema:
91
+ type: string
92
+ - name: fontName
93
+ in: path
94
+ required: true
95
+ schema:
96
+ type: string
97
+ - name: v
98
+ in: query
99
+ description: API version
100
+ schema:
101
+ type: string
102
+ - name: api-version
103
+ in: query
104
+ description: API version
105
+ schema:
106
+ type: string
107
+ - name: X-API-VERSION
108
+ in: header
109
+ description: API version
110
+ schema:
111
+ type: string
112
+ - name: Accept-Version
113
+ in: header
114
+ description: API version
115
+ schema:
116
+ type: string
117
+ responses:
118
+ "200":
119
+ description: getFont 200 response
120
+ content:
121
+ font/ttf:
122
+ schema:
123
+ type: string
124
+ format: binary
125
+ /font/register:
126
+ post:
127
+ operationId: registerFont
128
+ parameters:
129
+ - name: X-Session-Id
130
+ in: header
131
+ required: true
132
+ schema:
133
+ type: string
134
+ - name: v
135
+ in: query
136
+ description: API version
137
+ schema:
138
+ type: string
139
+ - name: api-version
140
+ in: query
141
+ description: API version
142
+ schema:
143
+ type: string
144
+ - name: X-API-VERSION
145
+ in: header
146
+ description: API version
147
+ schema:
148
+ type: string
149
+ - name: Accept-Version
150
+ in: header
151
+ description: API version
152
+ schema:
153
+ type: string
154
+ requestBody:
155
+ content:
156
+ multipart/form-data:
157
+ schema:
158
+ type: object
159
+ properties:
160
+ ttfFile:
161
+ type: string
162
+ format: binary
163
+ encoding:
164
+ ttfFile:
165
+ contentType: application/octet-stream
166
+ explode: false
167
+ required: true
168
+ responses:
169
+ "200":
170
+ description: registerFont 200 response
171
+ content:
172
+ application/json:
173
+ schema:
174
+ type: string
175
+ /me/tenant:
176
+ get:
177
+ operationId: getTenant
178
+ parameters:
179
+ - name: v
180
+ in: query
181
+ description: API version
182
+ schema:
183
+ type: string
184
+ - name: api-version
185
+ in: query
186
+ description: API version
187
+ schema:
188
+ type: string
189
+ - name: X-API-VERSION
190
+ in: header
191
+ description: API version
192
+ schema:
193
+ type: string
194
+ - name: Accept-Version
195
+ in: header
196
+ description: API version
197
+ schema:
198
+ type: string
199
+ responses:
200
+ "200":
201
+ description: getTenant 200 response
202
+ content:
203
+ application/json:
204
+ schema:
205
+ $ref: "#/components/schemas/UserTenantResponse"
206
+ /me/tokens:
207
+ get:
208
+ operationId: listTokens
209
+ parameters:
210
+ - name: v
211
+ in: query
212
+ description: API version
213
+ schema:
214
+ type: string
215
+ - name: api-version
216
+ in: query
217
+ description: API version
218
+ schema:
219
+ type: string
220
+ - name: X-API-VERSION
221
+ in: header
222
+ description: API version
223
+ schema:
224
+ type: string
225
+ - name: Accept-Version
226
+ in: header
227
+ description: API version
228
+ schema:
229
+ type: string
230
+ responses:
231
+ "200":
232
+ description: listTokens 200 response
233
+ content:
234
+ application/json:
235
+ schema:
236
+ type: array
237
+ items:
238
+ $ref: "#/components/schemas/ApiTokenListResponse"
239
+ post:
240
+ operationId: createToken
241
+ parameters:
242
+ - name: v
243
+ in: query
244
+ description: API version
245
+ schema:
246
+ type: string
247
+ - name: api-version
248
+ in: query
249
+ description: API version
250
+ schema:
251
+ type: string
252
+ - name: X-API-VERSION
253
+ in: header
254
+ description: API version
255
+ schema:
256
+ type: string
257
+ - name: Accept-Version
258
+ in: header
259
+ description: API version
260
+ schema:
261
+ type: string
262
+ requestBody:
263
+ content:
264
+ application/json:
265
+ schema:
266
+ $ref: "#/components/schemas/ApiTokenCreateRequest"
267
+ required: true
268
+ responses:
269
+ "200":
270
+ description: createToken 200 response
271
+ content:
272
+ application/json:
273
+ schema:
274
+ $ref: "#/components/schemas/ApiTokenCreateResponse"
275
+ /me/tokens/{tokenId}:
276
+ get:
277
+ operationId: getToken
278
+ parameters:
279
+ - name: tokenId
280
+ in: path
281
+ required: true
282
+ schema:
283
+ type: string
284
+ - name: v
285
+ in: query
286
+ description: API version
287
+ schema:
288
+ type: string
289
+ - name: api-version
290
+ in: query
291
+ description: API version
292
+ schema:
293
+ type: string
294
+ - name: X-API-VERSION
295
+ in: header
296
+ description: API version
297
+ schema:
298
+ type: string
299
+ - name: Accept-Version
300
+ in: header
301
+ description: API version
302
+ schema:
303
+ type: string
304
+ responses:
305
+ "200":
306
+ description: getToken 200 response
307
+ content:
308
+ application/json:
309
+ schema:
310
+ $ref: "#/components/schemas/ApiTokenListResponse"
311
+ delete:
312
+ operationId: revokeToken
313
+ parameters:
314
+ - name: tokenId
315
+ in: path
316
+ required: true
317
+ schema:
318
+ type: string
319
+ - name: v
320
+ in: query
321
+ description: API version
322
+ schema:
323
+ type: string
324
+ - name: api-version
325
+ in: query
326
+ description: API version
327
+ schema:
328
+ type: string
329
+ - name: X-API-VERSION
330
+ in: header
331
+ description: API version
332
+ schema:
333
+ type: string
334
+ - name: Accept-Version
335
+ in: header
336
+ description: API version
337
+ schema:
338
+ type: string
339
+ responses:
340
+ "200":
341
+ description: revokeToken 200 response
342
+ /pdf/add:
343
+ post:
344
+ operationId: addObject
345
+ parameters:
346
+ - name: X-Session-Id
347
+ in: header
348
+ required: true
349
+ schema:
350
+ type: string
351
+ - name: v
352
+ in: query
353
+ description: API version
354
+ schema:
355
+ type: string
356
+ - name: api-version
357
+ in: query
358
+ description: API version
359
+ schema:
360
+ type: string
361
+ - name: X-API-VERSION
362
+ in: header
363
+ description: API version
364
+ schema:
365
+ type: string
366
+ - name: Accept-Version
367
+ in: header
368
+ description: API version
369
+ schema:
370
+ type: string
371
+ requestBody:
372
+ content:
373
+ application/json:
374
+ schema:
375
+ $ref: "#/components/schemas/AddRequest"
376
+ required: true
377
+ responses:
378
+ "200":
379
+ description: addObject 200 response
380
+ content:
381
+ application/json:
382
+ schema:
383
+ type: boolean
384
+ /pdf/delete:
385
+ delete:
386
+ operationId: deleteObject
387
+ parameters:
388
+ - name: X-Session-Id
389
+ in: header
390
+ required: true
391
+ schema:
392
+ type: string
393
+ - name: v
394
+ in: query
395
+ description: API version
396
+ schema:
397
+ type: string
398
+ - name: api-version
399
+ in: query
400
+ description: API version
401
+ schema:
402
+ type: string
403
+ - name: X-API-VERSION
404
+ in: header
405
+ description: API version
406
+ schema:
407
+ type: string
408
+ - name: Accept-Version
409
+ in: header
410
+ description: API version
411
+ schema:
412
+ type: string
413
+ requestBody:
414
+ content:
415
+ application/json:
416
+ schema:
417
+ $ref: "#/components/schemas/DeleteRequest"
418
+ required: true
419
+ responses:
420
+ "200":
421
+ description: deleteObject 200 response
422
+ content:
423
+ application/json:
424
+ schema:
425
+ type: boolean
426
+ /pdf/document/snapshot:
427
+ get:
428
+ operationId: getDocumentSnapshot
429
+ parameters:
430
+ - name: X-Session-Id
431
+ in: header
432
+ required: true
433
+ schema:
434
+ type: string
435
+ - name: types
436
+ in: query
437
+ explode: false
438
+ schema:
439
+ type: string
440
+ nullable: true
441
+ - name: v
442
+ in: query
443
+ description: API version
444
+ schema:
445
+ type: string
446
+ - name: api-version
447
+ in: query
448
+ description: API version
449
+ schema:
450
+ type: string
451
+ - name: X-API-VERSION
452
+ in: header
453
+ description: API version
454
+ schema:
455
+ type: string
456
+ - name: Accept-Version
457
+ in: header
458
+ description: API version
459
+ schema:
460
+ type: string
461
+ responses:
462
+ "200":
463
+ description: getDocumentSnapshot 200 response
464
+ content:
465
+ application/json:
466
+ schema:
467
+ $ref: "#/components/schemas/DocumentSnapshot"
468
+ /pdf/find:
469
+ post:
470
+ operationId: findObject
471
+ parameters:
472
+ - name: X-Session-Id
473
+ in: header
474
+ required: true
475
+ schema:
476
+ type: string
477
+ - name: v
478
+ in: query
479
+ description: API version
480
+ schema:
481
+ type: string
482
+ - name: api-version
483
+ in: query
484
+ description: API version
485
+ schema:
486
+ type: string
487
+ - name: X-API-VERSION
488
+ in: header
489
+ description: API version
490
+ schema:
491
+ type: string
492
+ - name: Accept-Version
493
+ in: header
494
+ description: API version
495
+ schema:
496
+ type: string
497
+ requestBody:
498
+ content:
499
+ application/json:
500
+ schema:
501
+ $ref: "#/components/schemas/FindRequest"
502
+ required: true
503
+ responses:
504
+ "200":
505
+ description: findObject 200 response
506
+ content:
507
+ application/json:
508
+ schema:
509
+ type: array
510
+ items:
511
+ $ref: "#/components/schemas/ObjectRef"
512
+ /pdf/modify:
513
+ put:
514
+ operationId: modifyObject
515
+ parameters:
516
+ - name: X-Session-Id
517
+ in: header
518
+ required: true
519
+ schema:
520
+ type: string
521
+ - name: v
522
+ in: query
523
+ description: API version
524
+ schema:
525
+ type: string
526
+ - name: api-version
527
+ in: query
528
+ description: API version
529
+ schema:
530
+ type: string
531
+ - name: X-API-VERSION
532
+ in: header
533
+ description: API version
534
+ schema:
535
+ type: string
536
+ - name: Accept-Version
537
+ in: header
538
+ description: API version
539
+ schema:
540
+ type: string
541
+ requestBody:
542
+ content:
543
+ application/json:
544
+ schema:
545
+ $ref: "#/components/schemas/ModifyRequest"
546
+ required: true
547
+ responses:
548
+ "200":
549
+ description: modifyObject 200 response
550
+ content:
551
+ application/json:
552
+ schema:
553
+ $ref: "#/components/schemas/CommandResult"
554
+ /pdf/modify/formField:
555
+ put:
556
+ operationId: changeFormField
557
+ parameters:
558
+ - name: X-Session-Id
559
+ in: header
560
+ required: true
561
+ schema:
562
+ type: string
563
+ - name: v
564
+ in: query
565
+ description: API version
566
+ schema:
567
+ type: string
568
+ - name: api-version
569
+ in: query
570
+ description: API version
571
+ schema:
572
+ type: string
573
+ - name: X-API-VERSION
574
+ in: header
575
+ description: API version
576
+ schema:
577
+ type: string
578
+ - name: Accept-Version
579
+ in: header
580
+ description: API version
581
+ schema:
582
+ type: string
583
+ requestBody:
584
+ content:
585
+ application/json:
586
+ schema:
587
+ $ref: "#/components/schemas/ChangeFormFieldRequest"
588
+ required: true
589
+ responses:
590
+ "200":
591
+ description: changeFormField 200 response
592
+ content:
593
+ application/json:
594
+ schema:
595
+ type: boolean
596
+ /pdf/move:
597
+ put:
598
+ operationId: moveObject
599
+ parameters:
600
+ - name: X-Session-Id
601
+ in: header
602
+ required: true
603
+ schema:
604
+ type: string
605
+ - name: v
606
+ in: query
607
+ description: API version
608
+ schema:
609
+ type: string
610
+ - name: api-version
611
+ in: query
612
+ description: API version
613
+ schema:
614
+ type: string
615
+ - name: X-API-VERSION
616
+ in: header
617
+ description: API version
618
+ schema:
619
+ type: string
620
+ - name: Accept-Version
621
+ in: header
622
+ description: API version
623
+ schema:
624
+ type: string
625
+ requestBody:
626
+ content:
627
+ application/json:
628
+ schema:
629
+ $ref: "#/components/schemas/MoveRequest"
630
+ required: true
631
+ responses:
632
+ "200":
633
+ description: moveObject 200 response
634
+ content:
635
+ application/json:
636
+ schema:
637
+ type: boolean
638
+ /pdf/page/add:
639
+ post:
640
+ operationId: addPage
641
+ parameters:
642
+ - name: X-Session-Id
643
+ in: header
644
+ required: true
645
+ schema:
646
+ type: string
647
+ - name: v
648
+ in: query
649
+ description: API version
650
+ schema:
651
+ type: string
652
+ - name: api-version
653
+ in: query
654
+ description: API version
655
+ schema:
656
+ type: string
657
+ - name: X-API-VERSION
658
+ in: header
659
+ description: API version
660
+ schema:
661
+ type: string
662
+ - name: Accept-Version
663
+ in: header
664
+ description: API version
665
+ schema:
666
+ type: string
667
+ responses:
668
+ "200":
669
+ description: addPage 200 response
670
+ content:
671
+ application/json:
672
+ schema:
673
+ $ref: "#/components/schemas/PageRef"
674
+ /pdf/page/delete:
675
+ delete:
676
+ operationId: deletePage
677
+ parameters:
678
+ - name: X-Session-Id
679
+ in: header
680
+ required: true
681
+ schema:
682
+ type: string
683
+ - name: v
684
+ in: query
685
+ description: API version
686
+ schema:
687
+ type: string
688
+ - name: api-version
689
+ in: query
690
+ description: API version
691
+ schema:
692
+ type: string
693
+ - name: X-API-VERSION
694
+ in: header
695
+ description: API version
696
+ schema:
697
+ type: string
698
+ - name: Accept-Version
699
+ in: header
700
+ description: API version
701
+ schema:
702
+ type: string
703
+ requestBody:
704
+ content:
705
+ application/json:
706
+ schema:
707
+ $ref: "#/components/schemas/ObjectRef"
708
+ required: true
709
+ responses:
710
+ "200":
711
+ description: deletePage 200 response
712
+ content:
713
+ application/json:
714
+ schema:
715
+ type: boolean
716
+ /pdf/page/find:
717
+ post:
718
+ operationId: findPage
719
+ parameters:
720
+ - name: X-Session-Id
721
+ in: header
722
+ required: true
723
+ schema:
724
+ type: string
725
+ - name: pageIndex
726
+ in: query
727
+ explode: false
728
+ schema:
729
+ type: integer
730
+ format: int32
731
+ nullable: true
732
+ - name: v
733
+ in: query
734
+ description: API version
735
+ schema:
736
+ type: string
737
+ - name: api-version
738
+ in: query
739
+ description: API version
740
+ schema:
741
+ type: string
742
+ - name: X-API-VERSION
743
+ in: header
744
+ description: API version
745
+ schema:
746
+ type: string
747
+ - name: Accept-Version
748
+ in: header
749
+ description: API version
750
+ schema:
751
+ type: string
752
+ responses:
753
+ "200":
754
+ description: findPage 200 response
755
+ content:
756
+ application/json:
757
+ schema:
758
+ type: array
759
+ items:
760
+ $ref: "#/components/schemas/PageRef"
761
+ /pdf/page/modify:
762
+ put:
763
+ operationId: modifyPage
764
+ parameters:
765
+ - name: X-Session-Id
766
+ in: header
767
+ required: true
768
+ schema:
769
+ type: string
770
+ - name: v
771
+ in: query
772
+ description: API version
773
+ schema:
774
+ type: string
775
+ - name: api-version
776
+ in: query
777
+ description: API version
778
+ schema:
779
+ type: string
780
+ - name: X-API-VERSION
781
+ in: header
782
+ description: API version
783
+ schema:
784
+ type: string
785
+ - name: Accept-Version
786
+ in: header
787
+ description: API version
788
+ schema:
789
+ type: string
790
+ requestBody:
791
+ content:
792
+ application/json:
793
+ schema:
794
+ $ref: "#/components/schemas/ChangeFormFieldRequest"
795
+ required: true
796
+ responses:
797
+ "200":
798
+ description: modifyPage 200 response
799
+ content:
800
+ application/json:
801
+ schema:
802
+ type: boolean
803
+ /pdf/page/move:
804
+ put:
805
+ operationId: movePage
806
+ parameters:
807
+ - name: X-Session-Id
808
+ in: header
809
+ required: true
810
+ schema:
811
+ type: string
812
+ - name: v
813
+ in: query
814
+ description: API version
815
+ schema:
816
+ type: string
817
+ - name: api-version
818
+ in: query
819
+ description: API version
820
+ schema:
821
+ type: string
822
+ - name: X-API-VERSION
823
+ in: header
824
+ description: API version
825
+ schema:
826
+ type: string
827
+ - name: Accept-Version
828
+ in: header
829
+ description: API version
830
+ schema:
831
+ type: string
832
+ requestBody:
833
+ content:
834
+ application/json:
835
+ schema:
836
+ $ref: "#/components/schemas/PageMoveRequest"
837
+ required: true
838
+ responses:
839
+ "200":
840
+ description: movePage 200 response
841
+ content:
842
+ application/json:
843
+ schema:
844
+ type: boolean
845
+ /pdf/page/{pageIndex}/snapshot:
846
+ get:
847
+ operationId: getPageSnapshot
848
+ parameters:
849
+ - name: X-Session-Id
850
+ in: header
851
+ required: true
852
+ schema:
853
+ type: string
854
+ - name: pageIndex
855
+ in: path
856
+ required: true
857
+ schema:
858
+ type: integer
859
+ format: int32
860
+ - name: types
861
+ in: query
862
+ explode: false
863
+ schema:
864
+ type: string
865
+ nullable: true
866
+ - name: v
867
+ in: query
868
+ description: API version
869
+ schema:
870
+ type: string
871
+ - name: api-version
872
+ in: query
873
+ description: API version
874
+ schema:
875
+ type: string
876
+ - name: X-API-VERSION
877
+ in: header
878
+ description: API version
879
+ schema:
880
+ type: string
881
+ - name: Accept-Version
882
+ in: header
883
+ description: API version
884
+ schema:
885
+ type: string
886
+ responses:
887
+ "200":
888
+ description: getPageSnapshot 200 response
889
+ content:
890
+ application/json:
891
+ schema:
892
+ $ref: "#/components/schemas/PageSnapshot"
893
+ /pdf/text/line:
894
+ put:
895
+ operationId: modifyTextLine
896
+ parameters:
897
+ - name: X-Session-Id
898
+ in: header
899
+ required: true
900
+ schema:
901
+ type: string
902
+ - name: v
903
+ in: query
904
+ description: API version
905
+ schema:
906
+ type: string
907
+ - name: api-version
908
+ in: query
909
+ description: API version
910
+ schema:
911
+ type: string
912
+ - name: X-API-VERSION
913
+ in: header
914
+ description: API version
915
+ schema:
916
+ type: string
917
+ - name: Accept-Version
918
+ in: header
919
+ description: API version
920
+ schema:
921
+ type: string
922
+ requestBody:
923
+ content:
924
+ application/json:
925
+ schema:
926
+ $ref: "#/components/schemas/ModifyTextRequest"
927
+ required: true
928
+ responses:
929
+ "200":
930
+ description: modifyTextLine 200 response
931
+ content:
932
+ application/json:
933
+ schema:
934
+ $ref: "#/components/schemas/CommandResult"
935
+ /pdf/text/paragraph:
936
+ put:
937
+ operationId: modifyParagraph
938
+ parameters:
939
+ - name: X-Session-Id
940
+ in: header
941
+ required: true
942
+ schema:
943
+ type: string
944
+ - name: v
945
+ in: query
946
+ description: API version
947
+ schema:
948
+ type: string
949
+ - name: api-version
950
+ in: query
951
+ description: API version
952
+ schema:
953
+ type: string
954
+ - name: X-API-VERSION
955
+ in: header
956
+ description: API version
957
+ schema:
958
+ type: string
959
+ - name: Accept-Version
960
+ in: header
961
+ description: API version
962
+ schema:
963
+ type: string
964
+ requestBody:
965
+ content:
966
+ application/json:
967
+ schema:
968
+ $ref: "#/components/schemas/ModifyTextRequest"
969
+ required: true
970
+ responses:
971
+ "200":
972
+ description: modifyParagraph 200 response
973
+ content:
974
+ application/json:
975
+ schema:
976
+ $ref: "#/components/schemas/CommandResult"
977
+ /ping:
978
+ get:
979
+ operationId: index
980
+ parameters:
981
+ - name: v
982
+ in: query
983
+ description: API version
984
+ schema:
985
+ type: string
986
+ - name: api-version
987
+ in: query
988
+ description: API version
989
+ schema:
990
+ type: string
991
+ - name: X-API-VERSION
992
+ in: header
993
+ description: API version
994
+ schema:
995
+ type: string
996
+ - name: Accept-Version
997
+ in: header
998
+ description: API version
999
+ schema:
1000
+ type: string
1001
+ responses:
1002
+ "200":
1003
+ description: index 200 response
1004
+ content:
1005
+ text/plain:
1006
+ schema:
1007
+ type: string
1008
+ /product:
1009
+ get:
1010
+ operationId: getProducts
1011
+ parameters:
1012
+ - name: v
1013
+ in: query
1014
+ description: API version
1015
+ schema:
1016
+ type: string
1017
+ - name: api-version
1018
+ in: query
1019
+ description: API version
1020
+ schema:
1021
+ type: string
1022
+ - name: X-API-VERSION
1023
+ in: header
1024
+ description: API version
1025
+ schema:
1026
+ type: string
1027
+ - name: Accept-Version
1028
+ in: header
1029
+ description: API version
1030
+ schema:
1031
+ type: string
1032
+ responses:
1033
+ "200":
1034
+ description: getProducts 200 response
1035
+ content:
1036
+ application/json:
1037
+ schema:
1038
+ type: array
1039
+ items:
1040
+ $ref: "#/components/schemas/Product"
1041
+ /product/subscription:
1042
+ get:
1043
+ operationId: getSubscription
1044
+ parameters:
1045
+ - name: v
1046
+ in: query
1047
+ description: API version
1048
+ schema:
1049
+ type: string
1050
+ - name: api-version
1051
+ in: query
1052
+ description: API version
1053
+ schema:
1054
+ type: string
1055
+ - name: X-API-VERSION
1056
+ in: header
1057
+ description: API version
1058
+ schema:
1059
+ type: string
1060
+ - name: Accept-Version
1061
+ in: header
1062
+ description: API version
1063
+ schema:
1064
+ type: string
1065
+ responses:
1066
+ "200":
1067
+ description: getSubscription 200 response
1068
+ content:
1069
+ application/json:
1070
+ schema:
1071
+ $ref: "#/components/schemas/Subscription"
1072
+ /product/{productId}:
1073
+ get:
1074
+ operationId: getSessionPdf
1075
+ parameters:
1076
+ - name: productId
1077
+ in: path
1078
+ required: true
1079
+ schema:
1080
+ type: string
1081
+ - name: v
1082
+ in: query
1083
+ description: API version
1084
+ schema:
1085
+ type: string
1086
+ - name: api-version
1087
+ in: query
1088
+ description: API version
1089
+ schema:
1090
+ type: string
1091
+ - name: X-API-VERSION
1092
+ in: header
1093
+ description: API version
1094
+ schema:
1095
+ type: string
1096
+ - name: Accept-Version
1097
+ in: header
1098
+ description: API version
1099
+ schema:
1100
+ type: string
1101
+ responses:
1102
+ "200":
1103
+ description: getSessionPdf 200 response
1104
+ content:
1105
+ application/json:
1106
+ schema:
1107
+ $ref: "#/components/schemas/Product"
1108
+ /session/create:
1109
+ post:
1110
+ operationId: createSession
1111
+ parameters:
1112
+ - name: v
1113
+ in: query
1114
+ description: API version
1115
+ schema:
1116
+ type: string
1117
+ - name: api-version
1118
+ in: query
1119
+ description: API version
1120
+ schema:
1121
+ type: string
1122
+ - name: X-API-VERSION
1123
+ in: header
1124
+ description: API version
1125
+ schema:
1126
+ type: string
1127
+ - name: Accept-Version
1128
+ in: header
1129
+ description: API version
1130
+ schema:
1131
+ type: string
1132
+ requestBody:
1133
+ content:
1134
+ multipart/form-data:
1135
+ schema:
1136
+ type: object
1137
+ properties:
1138
+ pdf:
1139
+ type: string
1140
+ format: binary
1141
+ encoding:
1142
+ pdf:
1143
+ contentType: application/octet-stream
1144
+ explode: false
1145
+ required: true
1146
+ responses:
1147
+ "200":
1148
+ description: createSession 200 response
1149
+ content:
1150
+ application/json:
1151
+ schema:
1152
+ type: string
1153
+ /session/new:
1154
+ post:
1155
+ operationId: createBlankPdf
1156
+ parameters:
1157
+ - name: v
1158
+ in: query
1159
+ description: API version
1160
+ schema:
1161
+ type: string
1162
+ - name: api-version
1163
+ in: query
1164
+ description: API version
1165
+ schema:
1166
+ type: string
1167
+ - name: X-API-VERSION
1168
+ in: header
1169
+ description: API version
1170
+ schema:
1171
+ type: string
1172
+ - name: Accept-Version
1173
+ in: header
1174
+ description: API version
1175
+ schema:
1176
+ type: string
1177
+ requestBody:
1178
+ content:
1179
+ application/json:
1180
+ schema:
1181
+ $ref: "#/components/schemas/CreateBlankPdfRequest"
1182
+ required: true
1183
+ responses:
1184
+ "200":
1185
+ description: createBlankPdf 200 response
1186
+ content:
1187
+ application/json:
1188
+ schema:
1189
+ type: string
1190
+ /session/{sessionId}:
1191
+ delete:
1192
+ operationId: deleteSession
1193
+ parameters:
1194
+ - name: sessionId
1195
+ in: path
1196
+ required: true
1197
+ schema:
1198
+ type: string
1199
+ - name: v
1200
+ in: query
1201
+ description: API version
1202
+ schema:
1203
+ type: string
1204
+ - name: api-version
1205
+ in: query
1206
+ description: API version
1207
+ schema:
1208
+ type: string
1209
+ - name: X-API-VERSION
1210
+ in: header
1211
+ description: API version
1212
+ schema:
1213
+ type: string
1214
+ - name: Accept-Version
1215
+ in: header
1216
+ description: API version
1217
+ schema:
1218
+ type: string
1219
+ responses:
1220
+ "200":
1221
+ description: deleteSession 200 response
1222
+ content:
1223
+ application/json:
1224
+ schema:
1225
+ type: boolean
1226
+ /session/{sessionId}/pdf:
1227
+ get:
1228
+ operationId: getSessionPdf_1
1229
+ parameters:
1230
+ - name: sessionId
1231
+ in: path
1232
+ required: true
1233
+ schema:
1234
+ type: string
1235
+ - name: v
1236
+ in: query
1237
+ description: API version
1238
+ schema:
1239
+ type: string
1240
+ - name: api-version
1241
+ in: query
1242
+ description: API version
1243
+ schema:
1244
+ type: string
1245
+ - name: X-API-VERSION
1246
+ in: header
1247
+ description: API version
1248
+ schema:
1249
+ type: string
1250
+ - name: Accept-Version
1251
+ in: header
1252
+ description: API version
1253
+ schema:
1254
+ type: string
1255
+ responses:
1256
+ "200":
1257
+ description: getSessionPdf_1 200 response
1258
+ content:
1259
+ application/pdf:
1260
+ schema:
1261
+ type: string
1262
+ format: binary
1263
+ /test:
1264
+ get:
1265
+ operationId: test
1266
+ parameters:
1267
+ - name: v
1268
+ in: query
1269
+ description: API version
1270
+ schema:
1271
+ type: string
1272
+ - name: api-version
1273
+ in: query
1274
+ description: API version
1275
+ schema:
1276
+ type: string
1277
+ - name: X-API-VERSION
1278
+ in: header
1279
+ description: API version
1280
+ schema:
1281
+ type: string
1282
+ - name: Accept-Version
1283
+ in: header
1284
+ description: API version
1285
+ schema:
1286
+ type: string
1287
+ responses:
1288
+ "200":
1289
+ description: test 200 response
1290
+ content:
1291
+ text/plain:
1292
+ schema:
1293
+ type: string
1294
+ /user:
1295
+ get:
1296
+ operationId: info
1297
+ parameters:
1298
+ - name: v
1299
+ in: query
1300
+ description: API version
1301
+ schema:
1302
+ type: string
1303
+ - name: api-version
1304
+ in: query
1305
+ description: API version
1306
+ schema:
1307
+ type: string
1308
+ - name: X-API-VERSION
1309
+ in: header
1310
+ description: API version
1311
+ schema:
1312
+ type: string
1313
+ - name: Accept-Version
1314
+ in: header
1315
+ description: API version
1316
+ schema:
1317
+ type: string
1318
+ responses:
1319
+ "200":
1320
+ description: info 200 response
1321
+ content:
1322
+ application/json:
1323
+ schema:
1324
+ $ref: "#/components/schemas/Authentication"
1325
+ /version:
1326
+ get:
1327
+ operationId: getVersion
1328
+ parameters:
1329
+ - name: v
1330
+ in: query
1331
+ description: API version
1332
+ schema:
1333
+ type: string
1334
+ - name: api-version
1335
+ in: query
1336
+ description: API version
1337
+ schema:
1338
+ type: string
1339
+ - name: X-API-VERSION
1340
+ in: header
1341
+ description: API version
1342
+ schema:
1343
+ type: string
1344
+ - name: Accept-Version
1345
+ in: header
1346
+ description: API version
1347
+ schema:
1348
+ type: string
1349
+ responses:
1350
+ "200":
1351
+ description: getVersion 200 response
1352
+ content:
1353
+ application/json:
1354
+ schema:
1355
+ $ref: "#/components/schemas/VersionResponse"
1356
+ /xml:
1357
+ get:
1358
+ operationId: getSessionXml
1359
+ parameters:
1360
+ - name: X-Session-Id
1361
+ in: header
1362
+ required: true
1363
+ schema:
1364
+ type: string
1365
+ - name: v
1366
+ in: query
1367
+ description: API version
1368
+ schema:
1369
+ type: string
1370
+ - name: api-version
1371
+ in: query
1372
+ description: API version
1373
+ schema:
1374
+ type: string
1375
+ - name: X-API-VERSION
1376
+ in: header
1377
+ description: API version
1378
+ schema:
1379
+ type: string
1380
+ - name: Accept-Version
1381
+ in: header
1382
+ description: API version
1383
+ schema:
1384
+ type: string
1385
+ responses:
1386
+ "200":
1387
+ description: getSessionXml 200 response
1388
+ content:
1389
+ application/xml:
1390
+ schema:
1391
+ type: string
1392
+ format: binary
1393
+ components:
1394
+ schemas:
1395
+ AddRequest:
1396
+ required:
1397
+ - object
1398
+ type: object
1399
+ properties:
1400
+ object:
1401
+ $ref: "#/components/schemas/PDFObject"
1402
+ ApiTokenCreateRequest:
1403
+ required:
1404
+ - expiresAt
1405
+ - name
1406
+ type: object
1407
+ properties:
1408
+ name:
1409
+ type: string
1410
+ expiresAt:
1411
+ type: string
1412
+ ApiTokenCreateResponse:
1413
+ required:
1414
+ - metadata
1415
+ - token
1416
+ type: object
1417
+ properties:
1418
+ token:
1419
+ type: string
1420
+ metadata:
1421
+ $ref: "#/components/schemas/ApiTokenCreateResponse.ApiTokenMetadata"
1422
+ ApiTokenCreateResponse.ApiTokenMetadata:
1423
+ required:
1424
+ - createdAt
1425
+ - expiresAt
1426
+ - id
1427
+ - name
1428
+ - prefix
1429
+ type: object
1430
+ properties:
1431
+ id:
1432
+ type: string
1433
+ name:
1434
+ type: string
1435
+ prefix:
1436
+ type: string
1437
+ createdAt:
1438
+ type: string
1439
+ expiresAt:
1440
+ type: string
1441
+ ApiTokenListResponse:
1442
+ required:
1443
+ - createdAt
1444
+ - expiresAt
1445
+ - id
1446
+ - lastUsedAt
1447
+ - name
1448
+ - prefix
1449
+ type: object
1450
+ properties:
1451
+ id:
1452
+ type: string
1453
+ name:
1454
+ type: string
1455
+ prefix:
1456
+ type: string
1457
+ createdAt:
1458
+ type: string
1459
+ lastUsedAt:
1460
+ type: string
1461
+ expiresAt:
1462
+ type: string
1463
+ Authentication:
1464
+ required:
1465
+ - attributes
1466
+ - roles
1467
+ type: object
1468
+ allOf:
1469
+ - $ref: "#/components/schemas/Principal"
1470
+ - type: object
1471
+ properties:
1472
+ attributes:
1473
+ type: object
1474
+ additionalProperties:
1475
+ type: object
1476
+ roles:
1477
+ type: array
1478
+ items:
1479
+ type: string
1480
+ BoundingRect:
1481
+ required:
1482
+ - height
1483
+ - width
1484
+ - x
1485
+ - "y"
1486
+ type: object
1487
+ properties:
1488
+ origin:
1489
+ $ref: "#/components/schemas/Point"
1490
+ x:
1491
+ type: number
1492
+ format: double
1493
+ "y":
1494
+ type: number
1495
+ format: double
1496
+ width:
1497
+ type: number
1498
+ format: double
1499
+ height:
1500
+ type: number
1501
+ format: double
1502
+ ChangeFormFieldRequest:
1503
+ required:
1504
+ - ref
1505
+ - value
1506
+ type: object
1507
+ properties:
1508
+ ref:
1509
+ $ref: "#/components/schemas/ObjectRef"
1510
+ value:
1511
+ type: string
1512
+ Color:
1513
+ type: object
1514
+ properties:
1515
+ red:
1516
+ type: integer
1517
+ format: int32
1518
+ green:
1519
+ type: integer
1520
+ format: int32
1521
+ blue:
1522
+ type: integer
1523
+ format: int32
1524
+ alpha:
1525
+ type: integer
1526
+ format: int32
1527
+ CommandResult:
1528
+ required:
1529
+ - commandName
1530
+ - elementId
1531
+ - message
1532
+ - success
1533
+ - warning
1534
+ type: object
1535
+ properties:
1536
+ commandName:
1537
+ type: string
1538
+ elementId:
1539
+ type: string
1540
+ message:
1541
+ type: string
1542
+ success:
1543
+ type: boolean
1544
+ warning:
1545
+ type: string
1546
+ CreateBlankPdfRequest:
1547
+ required:
1548
+ - initialPageCount
1549
+ - orientation
1550
+ - pageSize
1551
+ type: object
1552
+ properties:
1553
+ pageSize:
1554
+ $ref: "#/components/schemas/PageSize"
1555
+ orientation:
1556
+ $ref: "#/components/schemas/Orientation"
1557
+ initialPageCount:
1558
+ type: integer
1559
+ format: int32
1560
+ DeleteRequest:
1561
+ required:
1562
+ - objectRef
1563
+ type: object
1564
+ properties:
1565
+ objectRef:
1566
+ $ref: "#/components/schemas/ObjectRef"
1567
+ DocumentSnapshot:
1568
+ required:
1569
+ - fonts
1570
+ - pageCount
1571
+ - pages
1572
+ type: object
1573
+ properties:
1574
+ pageCount:
1575
+ type: integer
1576
+ format: int32
1577
+ fonts:
1578
+ type: array
1579
+ items:
1580
+ $ref: "#/components/schemas/FontRecommendationDto"
1581
+ pages:
1582
+ type: array
1583
+ items:
1584
+ $ref: "#/components/schemas/PageSnapshot"
1585
+ FindRequest:
1586
+ required:
1587
+ - hint
1588
+ - objectType
1589
+ - position
1590
+ type: object
1591
+ properties:
1592
+ objectType:
1593
+ $ref: "#/components/schemas/ObjectType"
1594
+ position:
1595
+ $ref: "#/components/schemas/Position"
1596
+ hint:
1597
+ type: string
1598
+ Font:
1599
+ type: object
1600
+ properties:
1601
+ name:
1602
+ type: string
1603
+ size:
1604
+ type: number
1605
+ format: double
1606
+ embedded:
1607
+ type: boolean
1608
+ FontRecommendationDto:
1609
+ required:
1610
+ - fontName
1611
+ - fontType
1612
+ - similarityScore
1613
+ type: object
1614
+ properties:
1615
+ fontName:
1616
+ type: string
1617
+ fontType:
1618
+ $ref: "#/components/schemas/FontType"
1619
+ similarityScore:
1620
+ type: number
1621
+ format: double
1622
+ FontType:
1623
+ type: string
1624
+ enum:
1625
+ - SYSTEM
1626
+ - STANDARD
1627
+ - EMBEDDED
1628
+ Form:
1629
+ type: object
1630
+ allOf:
1631
+ - $ref: "#/components/schemas/PDFObject"
1632
+ - type: object
1633
+ properties:
1634
+ name:
1635
+ type: string
1636
+ type:
1637
+ $ref: "#/components/schemas/Form.FormType"
1638
+ value:
1639
+ type: string
1640
+ size:
1641
+ $ref: "#/components/schemas/Size"
1642
+ font:
1643
+ $ref: "#/components/schemas/Font"
1644
+ objectType:
1645
+ $ref: "#/components/schemas/ObjectType"
1646
+ Form.FormType:
1647
+ type: string
1648
+ enum:
1649
+ - TEXT_FIELD
1650
+ - CHECKBOX
1651
+ - RADIO_BUTTON
1652
+ - DROPDOWN
1653
+ - BUTTON
1654
+ Image:
1655
+ type: object
1656
+ allOf:
1657
+ - $ref: "#/components/schemas/PDFObject"
1658
+ - type: object
1659
+ properties:
1660
+ format:
1661
+ type: string
1662
+ size:
1663
+ $ref: "#/components/schemas/Size"
1664
+ data:
1665
+ type: string
1666
+ format: byte
1667
+ objectType:
1668
+ $ref: "#/components/schemas/ObjectType"
1669
+ ModifyRequest:
1670
+ required:
1671
+ - newObject
1672
+ - ref
1673
+ type: object
1674
+ properties:
1675
+ ref:
1676
+ $ref: "#/components/schemas/ObjectRef"
1677
+ newObject:
1678
+ $ref: "#/components/schemas/PDFObject"
1679
+ ModifyTextRequest:
1680
+ required:
1681
+ - newTextLine
1682
+ - ref
1683
+ type: object
1684
+ properties:
1685
+ ref:
1686
+ $ref: "#/components/schemas/ObjectRef"
1687
+ newTextLine:
1688
+ type: string
1689
+ MoveRequest:
1690
+ required:
1691
+ - newPosition
1692
+ - objectRef
1693
+ type: object
1694
+ properties:
1695
+ objectRef:
1696
+ $ref: "#/components/schemas/ObjectRef"
1697
+ newPosition:
1698
+ $ref: "#/components/schemas/Position"
1699
+ ObjectRef:
1700
+ required:
1701
+ - internalId
1702
+ - position
1703
+ - type
1704
+ type: object
1705
+ properties:
1706
+ internalId:
1707
+ type: string
1708
+ position:
1709
+ $ref: "#/components/schemas/Position"
1710
+ type:
1711
+ $ref: "#/components/schemas/ObjectType"
1712
+ ObjectType:
1713
+ type: string
1714
+ enum:
1715
+ - PDF
1716
+ - PAGE
1717
+ - CHARACTER
1718
+ - PARAGRAPH
1719
+ - IMAGE
1720
+ - PATH
1721
+ - LINE
1722
+ - RECTANGLE
1723
+ - BEZIER
1724
+ - CLIPPING
1725
+ - FORM_X_OBJECT
1726
+ - FORM_FIELD
1727
+ - WORD
1728
+ - TEXT_LINE
1729
+ - TEXT_FIELD
1730
+ - RADIO_BUTTON
1731
+ - CHECK_BOX
1732
+ Orientation:
1733
+ type: string
1734
+ enum:
1735
+ - PORTRAIT
1736
+ - LANDSCAPE
1737
+ PDFObject:
1738
+ type: object
1739
+ properties:
1740
+ id:
1741
+ type: string
1742
+ position:
1743
+ $ref: "#/components/schemas/Position"
1744
+ objectType:
1745
+ $ref: "#/components/schemas/ObjectType"
1746
+ discriminator:
1747
+ propertyName: type
1748
+ mapping:
1749
+ PATH: "#/components/schemas/Path"
1750
+ image: "#/components/schemas/Image"
1751
+ path: "#/components/schemas/Path"
1752
+ paragraph: "#/components/schemas/Paragraph"
1753
+ IMAGE: "#/components/schemas/Image"
1754
+ form: "#/components/schemas/Form"
1755
+ FORM: "#/components/schemas/Form"
1756
+ PARAGRAPH: "#/components/schemas/Paragraph"
1757
+ TEXT_LINE: "#/components/schemas/TextLine"
1758
+ textLine: "#/components/schemas/TextLine"
1759
+ oneOf:
1760
+ - $ref: "#/components/schemas/Image"
1761
+ - $ref: "#/components/schemas/Path"
1762
+ - $ref: "#/components/schemas/Form"
1763
+ - $ref: "#/components/schemas/Paragraph"
1764
+ - $ref: "#/components/schemas/TextLine"
1765
+ PageMoveRequest:
1766
+ required:
1767
+ - fromPageIndex
1768
+ - toPageIndex
1769
+ type: object
1770
+ properties:
1771
+ fromPageIndex:
1772
+ type: integer
1773
+ format: int32
1774
+ toPageIndex:
1775
+ type: integer
1776
+ format: int32
1777
+ PageRef:
1778
+ required:
1779
+ - orientation
1780
+ - pageSize
1781
+ type: object
1782
+ allOf:
1783
+ - $ref: "#/components/schemas/ObjectRef"
1784
+ - type: object
1785
+ properties:
1786
+ pageSize:
1787
+ $ref: "#/components/schemas/PageSize"
1788
+ orientation:
1789
+ $ref: "#/components/schemas/Orientation"
1790
+ PageSize:
1791
+ type: object
1792
+ properties:
1793
+ name:
1794
+ type: string
1795
+ width:
1796
+ type: number
1797
+ format: double
1798
+ height:
1799
+ type: number
1800
+ format: double
1801
+ PageSnapshot:
1802
+ required:
1803
+ - elements
1804
+ - pageRef
1805
+ type: object
1806
+ properties:
1807
+ pageRef:
1808
+ $ref: "#/components/schemas/PageRef"
1809
+ elements:
1810
+ type: array
1811
+ items:
1812
+ $ref: "#/components/schemas/ObjectRef"
1813
+ Paragraph:
1814
+ type: object
1815
+ allOf:
1816
+ - $ref: "#/components/schemas/PDFObject"
1817
+ - type: object
1818
+ properties:
1819
+ objectType:
1820
+ $ref: "#/components/schemas/ObjectType"
1821
+ lines:
1822
+ type: array
1823
+ items:
1824
+ $ref: "#/components/schemas/TextLine"
1825
+ lineSpacings:
1826
+ type: array
1827
+ items:
1828
+ type: number
1829
+ format: double
1830
+ font:
1831
+ $ref: "#/components/schemas/Font"
1832
+ text:
1833
+ type: string
1834
+ Path:
1835
+ type: object
1836
+ allOf:
1837
+ - $ref: "#/components/schemas/PDFObject"
1838
+ - type: object
1839
+ properties:
1840
+ position:
1841
+ $ref: "#/components/schemas/Position"
1842
+ pathSegments:
1843
+ type: array
1844
+ items:
1845
+ $ref: "#/components/schemas/PathSegment"
1846
+ objectType:
1847
+ $ref: "#/components/schemas/ObjectType"
1848
+ PathSegment:
1849
+ type: object
1850
+ allOf:
1851
+ - $ref: "#/components/schemas/PDFObject"
1852
+ - type: object
1853
+ properties:
1854
+ strokeColor:
1855
+ $ref: "#/components/schemas/Color"
1856
+ fillColor:
1857
+ $ref: "#/components/schemas/Color"
1858
+ strokeWidth:
1859
+ type: number
1860
+ format: double
1861
+ Point:
1862
+ required:
1863
+ - x
1864
+ - "y"
1865
+ type: object
1866
+ properties:
1867
+ x:
1868
+ type: number
1869
+ format: double
1870
+ "y":
1871
+ type: number
1872
+ format: double
1873
+ Position:
1874
+ type: object
1875
+ properties:
1876
+ textStartsWith:
1877
+ type: string
1878
+ name:
1879
+ type: string
1880
+ textPattern:
1881
+ type: string
1882
+ x:
1883
+ type: number
1884
+ format: double
1885
+ "y":
1886
+ type: number
1887
+ format: double
1888
+ pageIndex:
1889
+ type: integer
1890
+ format: int32
1891
+ shape:
1892
+ $ref: "#/components/schemas/Position.ShapeType"
1893
+ mode:
1894
+ $ref: "#/components/schemas/Position.PositionMode"
1895
+ boundingRect:
1896
+ $ref: "#/components/schemas/BoundingRect"
1897
+ Position.PositionMode:
1898
+ type: string
1899
+ enum:
1900
+ - INTERSECT
1901
+ - CONTAINS
1902
+ Position.ShapeType:
1903
+ type: string
1904
+ enum:
1905
+ - POINT
1906
+ - LINE
1907
+ - CIRCLE
1908
+ - RECT
1909
+ Principal:
1910
+ type: object
1911
+ properties:
1912
+ name:
1913
+ type: string
1914
+ Product:
1915
+ required:
1916
+ - description
1917
+ - id
1918
+ - name
1919
+ - price
1920
+ - requiresContact
1921
+ - type
1922
+ type: object
1923
+ properties:
1924
+ id:
1925
+ type: string
1926
+ name:
1927
+ type: string
1928
+ description:
1929
+ type: string
1930
+ price:
1931
+ $ref: "#/components/schemas/RecurringPrice"
1932
+ type:
1933
+ $ref: "#/components/schemas/ProductType"
1934
+ requiresContact:
1935
+ type: boolean
1936
+ ProductType:
1937
+ type: string
1938
+ enum:
1939
+ - SAAS
1940
+ RecurringPrice:
1941
+ required:
1942
+ - currencyCode
1943
+ - discount
1944
+ - price
1945
+ - timeInterval
1946
+ type: object
1947
+ properties:
1948
+ currencyCode:
1949
+ type: string
1950
+ discount:
1951
+ type: number
1952
+ format: float
1953
+ price:
1954
+ type: integer
1955
+ format: int32
1956
+ timeInterval:
1957
+ $ref: "#/components/schemas/TimeInterval"
1958
+ Size:
1959
+ type: object
1960
+ properties:
1961
+ width:
1962
+ type: number
1963
+ format: double
1964
+ height:
1965
+ type: number
1966
+ format: double
1967
+ area:
1968
+ type: number
1969
+ format: double
1970
+ Subscription:
1971
+ required:
1972
+ - end
1973
+ - product
1974
+ - start
1975
+ type: object
1976
+ properties:
1977
+ start:
1978
+ type: string
1979
+ format: date-time
1980
+ end:
1981
+ type: string
1982
+ format: date-time
1983
+ product:
1984
+ $ref: "#/components/schemas/Product"
1985
+ TextElement:
1986
+ type: object
1987
+ allOf:
1988
+ - $ref: "#/components/schemas/PDFObject"
1989
+ - type: object
1990
+ properties:
1991
+ text:
1992
+ type: string
1993
+ font:
1994
+ $ref: "#/components/schemas/Font"
1995
+ color:
1996
+ $ref: "#/components/schemas/Color"
1997
+ objectType:
1998
+ $ref: "#/components/schemas/ObjectType"
1999
+ status:
2000
+ $ref: "#/components/schemas/TextStatus"
2001
+ TextLine:
2002
+ type: object
2003
+ allOf:
2004
+ - $ref: "#/components/schemas/PDFObject"
2005
+ - type: object
2006
+ properties:
2007
+ fontSize:
2008
+ type: number
2009
+ format: double
2010
+ fontName:
2011
+ type: string
2012
+ objectType:
2013
+ $ref: "#/components/schemas/ObjectType"
2014
+ textElements:
2015
+ type: array
2016
+ items:
2017
+ $ref: "#/components/schemas/TextElement"
2018
+ color:
2019
+ $ref: "#/components/schemas/Color"
2020
+ text:
2021
+ type: string
2022
+ TextStatus:
2023
+ required:
2024
+ - fontRecommendation
2025
+ - fontType
2026
+ type: object
2027
+ properties:
2028
+ modified:
2029
+ type: boolean
2030
+ encodable:
2031
+ type: boolean
2032
+ fontType:
2033
+ $ref: "#/components/schemas/FontType"
2034
+ fontRecommendation:
2035
+ $ref: "#/components/schemas/FontRecommendationDto"
2036
+ warning:
2037
+ type: string
2038
+ TimeInterval:
2039
+ type: string
2040
+ enum:
2041
+ - DAY
2042
+ - WEEK
2043
+ - MONTH
2044
+ - YEAR
2045
+ UserTenantResponse:
2046
+ required:
2047
+ - planCode
2048
+ - role
2049
+ - status
2050
+ - tenantId
2051
+ - tenantName
2052
+ - tenantSlug
2053
+ type: object
2054
+ properties:
2055
+ tenantId:
2056
+ type: string
2057
+ tenantName:
2058
+ type: string
2059
+ tenantSlug:
2060
+ type: string
2061
+ role:
2062
+ type: string
2063
+ planCode:
2064
+ type: string
2065
+ status:
2066
+ type: string
2067
+ VersionResponse:
2068
+ required:
2069
+ - color
2070
+ - gitCommit
2071
+ type: object
2072
+ properties:
2073
+ gitCommit:
2074
+ type: string
2075
+ color:
2076
+ type: string