groupdocs-parser-cloud 23.10.0 → 25.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/model.d.ts CHANGED
@@ -1,2206 +1,2211 @@
1
- /// <reference types="node" />
2
- /**
3
- * Represents an barcode.
4
- */
5
- export declare class Barcode {
6
- /**
7
- * Attribute type map
8
- */
9
- static attributeTypeMap: Array<{
10
- name: string;
11
- baseName: string;
12
- type: string;
13
- }>;
14
- /**
15
- * Returns attribute type map
16
- */
17
- static getAttributeTypeMap(): {
18
- name: string;
19
- baseName: string;
20
- type: string;
21
- }[];
22
- /**
23
- * Gets the name of the barcode type.
24
- */
25
- codeTypeName: string;
26
- /**
27
- * Gets the barcode value.
28
- */
29
- value: string;
30
- /**
31
- * Gets or sets the barcode download URL.
32
- */
33
- downloadUrl: string;
34
- constructor(init?: Partial<Barcode>);
35
- }
36
- /**
37
- * Represents page object with barcode.
38
- */
39
- export declare class BarcodePage {
40
- /**
41
- * Attribute type map
42
- */
43
- static attributeTypeMap: Array<{
44
- name: string;
45
- baseName: string;
46
- type: string;
47
- }>;
48
- /**
49
- * Returns attribute type map
50
- */
51
- static getAttributeTypeMap(): {
52
- name: string;
53
- baseName: string;
54
- type: string;
55
- }[];
56
- /**
57
- * The index of the page.
58
- */
59
- index: number;
60
- constructor(init?: Partial<BarcodePage>);
61
- }
62
- /**
63
- * Barcodes result.
64
- */
65
- export declare class BarcodesResult {
66
- /**
67
- * Attribute type map
68
- */
69
- static attributeTypeMap: Array<{
70
- name: string;
71
- baseName: string;
72
- type: string;
73
- }>;
74
- /**
75
- * Returns attribute type map
76
- */
77
- static getAttributeTypeMap(): {
78
- name: string;
79
- baseName: string;
80
- type: string;
81
- }[];
82
- /**
83
- * Gets or sets a collection of barcodes.
84
- */
85
- barcodes: Array<Barcode>;
86
- constructor(init?: Partial<BarcodesResult>);
87
- }
88
- /**
89
- * Represents a container item like Zip archive entity, email attachment, PDF Portfolio item and so on.
90
- */
91
- export declare class ContainerItem {
92
- /**
93
- * Attribute type map
94
- */
95
- static attributeTypeMap: Array<{
96
- name: string;
97
- baseName: string;
98
- type: string;
99
- }>;
100
- /**
101
- * Returns attribute type map
102
- */
103
- static getAttributeTypeMap(): {
104
- name: string;
105
- baseName: string;
106
- type: string;
107
- }[];
108
- /**
109
- * Gets or sets the name of the item.
110
- */
111
- name: string;
112
- /**
113
- * Gets or sets the full path of the item.
114
- */
115
- filePath: string;
116
- /**
117
- * Gets or sets the directory of the item.
118
- */
119
- directory: string;
120
- /**
121
- * Gets or sets the collection of metadata items.
122
- */
123
- metadata: {
124
- [key: string]: string;
125
- };
126
- constructor(init?: Partial<ContainerItem>);
127
- }
128
- /**
129
- * Container item info.
130
- */
131
- export declare class ContainerItemInfo {
132
- /**
133
- * Attribute type map
134
- */
135
- static attributeTypeMap: Array<{
136
- name: string;
137
- baseName: string;
138
- type: string;
139
- }>;
140
- /**
141
- * Returns attribute type map
142
- */
143
- static getAttributeTypeMap(): {
144
- name: string;
145
- baseName: string;
146
- type: string;
147
- }[];
148
- /**
149
- * The relative path of the container.
150
- */
151
- relativePath: string;
152
- /**
153
- * Password for processing password-protected container item.
154
- */
155
- password: string;
156
- constructor(init?: Partial<ContainerItemInfo>);
157
- }
158
- /**
159
- * Container result.
160
- */
161
- export declare class ContainerResult {
162
- /**
163
- * Attribute type map
164
- */
165
- static attributeTypeMap: Array<{
166
- name: string;
167
- baseName: string;
168
- type: string;
169
- }>;
170
- /**
171
- * Returns attribute type map
172
- */
173
- static getAttributeTypeMap(): {
174
- name: string;
175
- baseName: string;
176
- type: string;
177
- }[];
178
- /**
179
- * Gets or sets the collection of a container items like Zip archive entity, email attachment, PDF Portfolio item and so on.
180
- */
181
- containerItems: Array<ContainerItem>;
182
- constructor(init?: Partial<ContainerResult>);
183
- }
184
- /**
185
- * Class for rectangle coordinates.
186
- */
187
- export declare class Coordinates {
188
- /**
189
- * Attribute type map
190
- */
191
- static attributeTypeMap: Array<{
192
- name: string;
193
- baseName: string;
194
- type: string;
195
- }>;
196
- /**
197
- * Returns attribute type map
198
- */
199
- static getAttributeTypeMap(): {
200
- name: string;
201
- baseName: string;
202
- type: string;
203
- }[];
204
- /**
205
- * Gets or sets the y-coordinate of the top edge of the rectangular area.
206
- */
207
- top: number;
208
- /**
209
- * Gets or sets the y-coordinate of the bottom edge of the rectangular area.
210
- */
211
- bottom: number;
212
- /**
213
- * Gets or sets the x-coordinate of the left edge of the rectangular area.
214
- */
215
- left: number;
216
- /**
217
- * Gets or sets the x-coordinate of the right edge of the rectangular area.
218
- */
219
- right: number;
220
- constructor(init?: Partial<Coordinates>);
221
- }
222
- /**
223
- * Template methods options.
224
- */
225
- export declare class CreateTemplateOptions {
226
- /**
227
- * Attribute type map
228
- */
229
- static attributeTypeMap: Array<{
230
- name: string;
231
- baseName: string;
232
- type: string;
233
- }>;
234
- /**
235
- * Returns attribute type map
236
- */
237
- static getAttributeTypeMap(): {
238
- name: string;
239
- baseName: string;
240
- type: string;
241
- }[];
242
- /**
243
- * Gets or sets the template.
244
- */
245
- template: Template;
246
- /**
247
- * Gets or sets the template path.
248
- */
249
- templatePath: string;
250
- /**
251
- * Gets or sets the name of the storage.
252
- */
253
- storageName: string;
254
- constructor(init?: Partial<CreateTemplateOptions>);
255
- }
256
- /**
257
- * Provides parameters for the table detection algorithms.
258
- */
259
- export declare class DetectorParameters {
260
- /**
261
- * Attribute type map
262
- */
263
- static attributeTypeMap: Array<{
264
- name: string;
265
- baseName: string;
266
- type: string;
267
- }>;
268
- /**
269
- * Returns attribute type map
270
- */
271
- static getAttributeTypeMap(): {
272
- name: string;
273
- baseName: string;
274
- type: string;
275
- }[];
276
- /**
277
- * Gets or sets the minimum number of the table rows.
278
- */
279
- minRowCount: number;
280
- /**
281
- * Gets or sets the minimum number of the table columns.
282
- */
283
- minColumnCount: number;
284
- /**
285
- * Gets or sets the minimum space between the table columns.
286
- */
287
- minVerticalSpace: number;
288
- /**
289
- * Gets or sets the value that indicates whether the table has merged cells.
290
- */
291
- hasMergedCells: boolean;
292
- /**
293
- * Gets or sets the rectangular area that contains the table.
294
- */
295
- rectangle: Rectangle;
296
- /**
297
- * Gets or sets the table columns separators.
298
- */
299
- verticalSeparators: Array<number>;
300
- constructor(init?: Partial<DetectorParameters>);
301
- }
302
- /**
303
- * Class for disc space information.
304
- */
305
- export declare class DiscUsage {
306
- /**
307
- * Attribute type map
308
- */
309
- static attributeTypeMap: Array<{
310
- name: string;
311
- baseName: string;
312
- type: string;
313
- }>;
314
- /**
315
- * Returns attribute type map
316
- */
317
- static getAttributeTypeMap(): {
318
- name: string;
319
- baseName: string;
320
- type: string;
321
- }[];
322
- /**
323
- * Application used disc space.
324
- */
325
- usedSize: number;
326
- /**
327
- * Total disc space.
328
- */
329
- totalSize: number;
330
- constructor(init?: Partial<DiscUsage>);
331
- }
332
- /**
333
- * The error details
334
- */
335
- export declare class ErrorDetails {
336
- /**
337
- * Attribute type map
338
- */
339
- static attributeTypeMap: Array<{
340
- name: string;
341
- baseName: string;
342
- type: string;
343
- }>;
344
- /**
345
- * Returns attribute type map
346
- */
347
- static getAttributeTypeMap(): {
348
- name: string;
349
- baseName: string;
350
- type: string;
351
- }[];
352
- /**
353
- * The request id
354
- */
355
- requestId: string;
356
- /**
357
- * Date
358
- */
359
- date: Date;
360
- constructor(init?: Partial<ErrorDetails>);
361
- }
362
- /**
363
- * Field of document template
364
- */
365
- export declare class Field {
366
- /**
367
- * Attribute type map
368
- */
369
- static attributeTypeMap: Array<{
370
- name: string;
371
- baseName: string;
372
- type: string;
373
- }>;
374
- /**
375
- * Returns attribute type map
376
- */
377
- static getAttributeTypeMap(): {
378
- name: string;
379
- baseName: string;
380
- type: string;
381
- }[];
382
- /**
383
- * A unique template field name.
384
- */
385
- fieldName: string;
386
- /**
387
- * The page index. An integer value that represents the index of the page where the template item is located; null if the template item is located on any page.
388
- */
389
- pageIndex: number;
390
- /**
391
- * Defines the way how to find the field on a page.
392
- */
393
- fieldPosition: FieldPosition;
394
- constructor(init?: Partial<Field>);
395
- }
396
- /**
397
- * Class for document field data.
398
- */
399
- export declare class FieldData {
400
- /**
401
- * Attribute type map
402
- */
403
- static attributeTypeMap: Array<{
404
- name: string;
405
- baseName: string;
406
- type: string;
407
- }>;
408
- /**
409
- * Returns attribute type map
410
- */
411
- static getAttributeTypeMap(): {
412
- name: string;
413
- baseName: string;
414
- type: string;
415
- }[];
416
- /**
417
- * Gets or sets the field name.
418
- */
419
- name: string;
420
- /**
421
- * Gets or sets the index of the page.
422
- */
423
- pageIndex: number;
424
- /**
425
- * Gets or sets the value of the field.
426
- */
427
- pageArea: PageArea;
428
- /**
429
- * Gets or sets the linked data field.
430
- */
431
- linkedField: FieldData;
432
- constructor(init?: Partial<FieldData>);
433
- }
434
- /**
435
- * Field position class.
436
- */
437
- export declare class FieldPosition {
438
- /**
439
- * Attribute type map
440
- */
441
- static attributeTypeMap: Array<{
442
- name: string;
443
- baseName: string;
444
- type: string;
445
- }>;
446
- /**
447
- * Returns attribute type map
448
- */
449
- static getAttributeTypeMap(): {
450
- name: string;
451
- baseName: string;
452
- type: string;
453
- }[];
454
- /**
455
- * Provides a template field position.
456
- */
457
- fieldPositionType: string;
458
- /**
459
- * Rectangular area on the page that bounds the field value.
460
- */
461
- rectangle: Rectangle;
462
- /**
463
- * Gets or sets the regular expression.
464
- */
465
- regex: string;
466
- /**
467
- * Gets or sets the value that indicates whether a text case isn't ignored.
468
- */
469
- matchCase: boolean;
470
- /**
471
- * Gets or sets the name of the linked field.
472
- */
473
- linkedFieldName: string;
474
- /**
475
- * Gets or sets the value that indicates whether a field is searched by the left from the linked field.
476
- */
477
- isLeftLinked: boolean;
478
- /**
479
- * Gets or sets a value indicating whether this instance is right linked.
480
- */
481
- isRightLinked: boolean;
482
- /**
483
- * Gets or sets a value indicating whether this instance is top linked.
484
- */
485
- isTopLinked: boolean;
486
- /**
487
- * Gets or sets a value indicating whether this instance is bottom linked.
488
- */
489
- isBottomLinked: boolean;
490
- /**
491
- * Gets or sets the size of the area where a field is searched.
492
- */
493
- searchArea: Size;
494
- /**
495
- * Gets or sets Gets the value that indicates whether SearchArea is scaled by the linked field size.
496
- */
497
- autoScale: boolean;
498
- constructor(init?: Partial<FieldPosition>);
499
- }
500
- /**
501
- * File info
502
- */
503
- export declare class FileInfo {
504
- /**
505
- * Attribute type map
506
- */
507
- static attributeTypeMap: Array<{
508
- name: string;
509
- baseName: string;
510
- type: string;
511
- }>;
512
- /**
513
- * Returns attribute type map
514
- */
515
- static getAttributeTypeMap(): {
516
- name: string;
517
- baseName: string;
518
- type: string;
519
- }[];
520
- /**
521
- * File path in storage
522
- */
523
- filePath: string;
524
- /**
525
- * Storage name
526
- */
527
- storageName: string;
528
- /**
529
- * Password to open file
530
- */
531
- password: string;
532
- constructor(init?: Partial<FileInfo>);
533
- }
534
- /**
535
- * Represents the file type.
536
- */
537
- export declare class FileType {
538
- /**
539
- * Attribute type map
540
- */
541
- static attributeTypeMap: Array<{
542
- name: string;
543
- baseName: string;
544
- type: string;
545
- }>;
546
- /**
547
- * Returns attribute type map
548
- */
549
- static getAttributeTypeMap(): {
550
- name: string;
551
- baseName: string;
552
- type: string;
553
- }[];
554
- /**
555
- * Gets or sets the file type name e.g. \"Microsoft Word Document\".
556
- */
557
- fileFormat: string;
558
- /**
559
- * Gets or sets the filename suffix (including the period \".\") e.g. \".doc\".
560
- */
561
- extension: string;
562
- constructor(init?: Partial<FileType>);
563
- }
564
- /**
565
- * File versions FileVersion.
566
- */
567
- export declare class FileVersions {
568
- /**
569
- * Attribute type map
570
- */
571
- static attributeTypeMap: Array<{
572
- name: string;
573
- baseName: string;
574
- type: string;
575
- }>;
576
- /**
577
- * Returns attribute type map
578
- */
579
- static getAttributeTypeMap(): {
580
- name: string;
581
- baseName: string;
582
- type: string;
583
- }[];
584
- /**
585
- * File versions FileVersion.
586
- */
587
- value: Array<FileVersion>;
588
- constructor(init?: Partial<FileVersions>);
589
- }
590
- /**
591
- * Files list
592
- */
593
- export declare class FilesList {
594
- /**
595
- * Attribute type map
596
- */
597
- static attributeTypeMap: Array<{
598
- name: string;
599
- baseName: string;
600
- type: string;
601
- }>;
602
- /**
603
- * Returns attribute type map
604
- */
605
- static getAttributeTypeMap(): {
606
- name: string;
607
- baseName: string;
608
- type: string;
609
- }[];
610
- /**
611
- * Files and folders contained by folder StorageFile.
612
- */
613
- value: Array<StorageFile>;
614
- constructor(init?: Partial<FilesList>);
615
- }
616
- /**
617
- * File upload result
618
- */
619
- export declare class FilesUploadResult {
620
- /**
621
- * Attribute type map
622
- */
623
- static attributeTypeMap: Array<{
624
- name: string;
625
- baseName: string;
626
- type: string;
627
- }>;
628
- /**
629
- * Returns attribute type map
630
- */
631
- static getAttributeTypeMap(): {
632
- name: string;
633
- baseName: string;
634
- type: string;
635
- }[];
636
- /**
637
- * List of uploaded file names
638
- */
639
- uploaded: Array<string>;
640
- /**
641
- * List of errors.
642
- */
643
- errors: Array<Error>;
644
- constructor(init?: Partial<FilesUploadResult>);
645
- }
646
- /**
647
- * File-format
648
- */
649
- export declare class Format {
650
- /**
651
- * Attribute type map
652
- */
653
- static attributeTypeMap: Array<{
654
- name: string;
655
- baseName: string;
656
- type: string;
657
- }>;
658
- /**
659
- * Returns attribute type map
660
- */
661
- static getAttributeTypeMap(): {
662
- name: string;
663
- baseName: string;
664
- type: string;
665
- }[];
666
- /**
667
- * File extension
668
- */
669
- extension: string;
670
- /**
671
- * File format
672
- */
673
- fileFormat: string;
674
- constructor(init?: Partial<Format>);
675
- }
676
- /**
677
- * Describes object which contains list of supported file formats.
678
- */
679
- export declare class FormatsResult {
680
- /**
681
- * Attribute type map
682
- */
683
- static attributeTypeMap: Array<{
684
- name: string;
685
- baseName: string;
686
- type: string;
687
- }>;
688
- /**
689
- * Returns attribute type map
690
- */
691
- static getAttributeTypeMap(): {
692
- name: string;
693
- baseName: string;
694
- type: string;
695
- }[];
696
- /**
697
- * Supported file formats.
698
- */
699
- formats: Array<Format>;
700
- constructor(init?: Partial<FormatsResult>);
701
- }
702
- /**
703
- * Provides the options which are used for formatted text extraction.
704
- */
705
- export declare class FormattedTextOptions {
706
- /**
707
- * Attribute type map
708
- */
709
- static attributeTypeMap: Array<{
710
- name: string;
711
- baseName: string;
712
- type: string;
713
- }>;
714
- /**
715
- * Returns attribute type map
716
- */
717
- static getAttributeTypeMap(): {
718
- name: string;
719
- baseName: string;
720
- type: string;
721
- }[];
722
- /**
723
- * Gets or sets the formatted text extraction mode.
724
- */
725
- mode: string;
726
- constructor(init?: Partial<FormattedTextOptions>);
727
- }
728
- /**
729
- * Represents an image.
730
- */
731
- export declare class Image {
732
- /**
733
- * Attribute type map
734
- */
735
- static attributeTypeMap: Array<{
736
- name: string;
737
- baseName: string;
738
- type: string;
739
- }>;
740
- /**
741
- * Returns attribute type map
742
- */
743
- static getAttributeTypeMap(): {
744
- name: string;
745
- baseName: string;
746
- type: string;
747
- }[];
748
- /**
749
- * Gets or sets The path of the image, located in the storage.
750
- */
751
- path: string;
752
- /**
753
- * Gets or sets the image download URL.
754
- */
755
- downloadUrl: string;
756
- /**
757
- * Gets or sets the index of the page.
758
- */
759
- pageIndex: number;
760
- /**
761
- * Gets or sets the rotation of the image in degrees.
762
- */
763
- rotation: number;
764
- /**
765
- * Gets or sets the image file format.
766
- */
767
- fileFormat: string;
768
- /**
769
- * Gets or sets the rectangle area of the image.
770
- */
771
- rectangle: Rectangle;
772
- constructor(init?: Partial<Image>);
773
- }
774
- /**
775
- * Represents page object with image collection.
776
- */
777
- export declare class ImagePage {
778
- /**
779
- * Attribute type map
780
- */
781
- static attributeTypeMap: Array<{
782
- name: string;
783
- baseName: string;
784
- type: string;
785
- }>;
786
- /**
787
- * Returns attribute type map
788
- */
789
- static getAttributeTypeMap(): {
790
- name: string;
791
- baseName: string;
792
- type: string;
793
- }[];
794
- /**
795
- * The index of the page.
796
- */
797
- pageIndex: number;
798
- /**
799
- * collection of the page images.
800
- */
801
- images: Array<Image>;
802
- constructor(init?: Partial<ImagePage>);
803
- }
804
- /**
805
- * Images result.
806
- */
807
- export declare class ImagesResult {
808
- /**
809
- * Attribute type map
810
- */
811
- static attributeTypeMap: Array<{
812
- name: string;
813
- baseName: string;
814
- type: string;
815
- }>;
816
- /**
817
- * Returns attribute type map
818
- */
819
- static getAttributeTypeMap(): {
820
- name: string;
821
- baseName: string;
822
- type: string;
823
- }[];
824
- /**
825
- * Gets or sets a collection of images.
826
- */
827
- images: Array<Image>;
828
- /**
829
- * Collection of the extracted pages with images.
830
- */
831
- pages: Array<ImagePage>;
832
- constructor(init?: Partial<ImagesResult>);
833
- }
834
- /**
835
- * Info result.
836
- */
837
- export declare class InfoResult {
838
- /**
839
- * Attribute type map
840
- */
841
- static attributeTypeMap: Array<{
842
- name: string;
843
- baseName: string;
844
- type: string;
845
- }>;
846
- /**
847
- * Returns attribute type map
848
- */
849
- static getAttributeTypeMap(): {
850
- name: string;
851
- baseName: string;
852
- type: string;
853
- }[];
854
- /**
855
- * Gets or sets the type of the file.
856
- */
857
- fileType: FileType;
858
- /**
859
- * Gets or sets the size of the document in bytes.
860
- */
861
- size: number;
862
- /**
863
- * Gets or sets the total number of document pages.
864
- */
865
- pageCount: number;
866
- /**
867
- * Gets or sets the encoding.
868
- */
869
- encoding: string;
870
- constructor(init?: Partial<InfoResult>);
871
- }
872
- /**
873
- * Error
874
- */
875
- export declare class ModelError {
876
- /**
877
- * Attribute type map
878
- */
879
- static attributeTypeMap: Array<{
880
- name: string;
881
- baseName: string;
882
- type: string;
883
- }>;
884
- /**
885
- * Returns attribute type map
886
- */
887
- static getAttributeTypeMap(): {
888
- name: string;
889
- baseName: string;
890
- type: string;
891
- }[];
892
- /**
893
- * Code
894
- */
895
- code: string;
896
- /**
897
- * Message
898
- */
899
- message: string;
900
- /**
901
- * Description
902
- */
903
- description: string;
904
- /**
905
- * Inner Error
906
- */
907
- innerError: ErrorDetails;
908
- constructor(init?: Partial<ModelError>);
909
- }
910
- /**
911
- * Object exists
912
- */
913
- export declare class ObjectExist {
914
- /**
915
- * Attribute type map
916
- */
917
- static attributeTypeMap: Array<{
918
- name: string;
919
- baseName: string;
920
- type: string;
921
- }>;
922
- /**
923
- * Returns attribute type map
924
- */
925
- static getAttributeTypeMap(): {
926
- name: string;
927
- baseName: string;
928
- type: string;
929
- }[];
930
- /**
931
- * Indicates that the file or folder exists.
932
- */
933
- exists: boolean;
934
- /**
935
- * True if it is a folder, false if it is a file.
936
- */
937
- isFolder: boolean;
938
- constructor(init?: Partial<ObjectExist>);
939
- }
940
- /**
941
- * The document page information such as page index and page size.
942
- */
943
- export declare class Page {
944
- /**
945
- * Attribute type map
946
- */
947
- static attributeTypeMap: Array<{
948
- name: string;
949
- baseName: string;
950
- type: string;
951
- }>;
952
- /**
953
- * Returns attribute type map
954
- */
955
- static getAttributeTypeMap(): {
956
- name: string;
957
- baseName: string;
958
- type: string;
959
- }[];
960
- /**
961
- * Gets or sets the index of the page.
962
- */
963
- index: number;
964
- /**
965
- * Gets or sets the size of the page.
966
- */
967
- size: Size;
968
- constructor(init?: Partial<Page>);
969
- }
970
- /**
971
- * Class for document page area.
972
- */
973
- export declare class PageArea {
974
- /**
975
- * Attribute type map
976
- */
977
- static attributeTypeMap: Array<{
978
- name: string;
979
- baseName: string;
980
- type: string;
981
- }>;
982
- /**
983
- * Returns attribute type map
984
- */
985
- static getAttributeTypeMap(): {
986
- name: string;
987
- baseName: string;
988
- type: string;
989
- }[];
990
- /**
991
- * Gets or sets the rectangular area.
992
- */
993
- rectangle: Rectangle;
994
- /**
995
- * Gets or sets the document page information such as page index and page size.
996
- */
997
- page: Page;
998
- /**
999
- * Gets or sets the text area. Represents a page text area which is used to represent a text value in the parsing by template functionality.
1000
- */
1001
- pageTextArea: PageTextArea;
1002
- /**
1003
- * Gets or sets the table area. Represents a table page area which is used to represent a table in the parsing by template functionality.
1004
- */
1005
- pageTableArea: PageTableArea;
1006
- constructor(init?: Partial<PageArea>);
1007
- }
1008
- /**
1009
- * Represents a table page area which is used to represent a table in the parsing by template functionality.
1010
- */
1011
- export declare class PageTableArea {
1012
- /**
1013
- * Attribute type map
1014
- */
1015
- static attributeTypeMap: Array<{
1016
- name: string;
1017
- baseName: string;
1018
- type: string;
1019
- }>;
1020
- /**
1021
- * Returns attribute type map
1022
- */
1023
- static getAttributeTypeMap(): {
1024
- name: string;
1025
- baseName: string;
1026
- type: string;
1027
- }[];
1028
- /**
1029
- * Gets or sets the total number of the table rows.
1030
- */
1031
- rowCount: number;
1032
- /**
1033
- * Gets or sets the total number of the table columns.
1034
- */
1035
- columnCount: number;
1036
- /**
1037
- * Gets or sets the collection of table area cell.
1038
- */
1039
- pageTableAreaCells: Array<PageTableAreaCell>;
1040
- constructor(init?: Partial<PageTableArea>);
1041
- }
1042
- /**
1043
- * Represents a table cell.
1044
- */
1045
- export declare class PageTableAreaCell {
1046
- /**
1047
- * Attribute type map
1048
- */
1049
- static attributeTypeMap: Array<{
1050
- name: string;
1051
- baseName: string;
1052
- type: string;
1053
- }>;
1054
- /**
1055
- * Returns attribute type map
1056
- */
1057
- static getAttributeTypeMap(): {
1058
- name: string;
1059
- baseName: string;
1060
- type: string;
1061
- }[];
1062
- /**
1063
- * Gets or sets the index of the column.
1064
- */
1065
- columnIndex: number;
1066
- /**
1067
- * Gets or sets the total number of columns that contain the table cell.
1068
- */
1069
- columnSpan: number;
1070
- /**
1071
- * Gets or sets the table cell value.
1072
- */
1073
- pageArea: PageArea;
1074
- /**
1075
- * Gets or sets the index of the row.
1076
- */
1077
- rowIndex: number;
1078
- /**
1079
- * Gets or sets the total number of rows that contain the table cell.
1080
- */
1081
- rowSpan: number;
1082
- constructor(init?: Partial<PageTableAreaCell>);
1083
- }
1084
- /**
1085
- * Represents a page text area which is used to represent a text value in the parsing by template functionality.
1086
- */
1087
- export declare class PageTextArea {
1088
- /**
1089
- * Attribute type map
1090
- */
1091
- static attributeTypeMap: Array<{
1092
- name: string;
1093
- baseName: string;
1094
- type: string;
1095
- }>;
1096
- /**
1097
- * Returns attribute type map
1098
- */
1099
- static getAttributeTypeMap(): {
1100
- name: string;
1101
- baseName: string;
1102
- type: string;
1103
- }[];
1104
- /**
1105
- * Gets or sets the text.
1106
- */
1107
- text: string;
1108
- /**
1109
- * Gets or sets the base line.
1110
- */
1111
- baseLine: number;
1112
- /**
1113
- * Gets or sets the collection of child text page areas.
1114
- */
1115
- areas: Array<PageTextArea>;
1116
- /**
1117
- * Gets or sets the text style such as font size, font name an so on.
1118
- */
1119
- textStyle: TextStyle;
1120
- constructor(init?: Partial<PageTextArea>);
1121
- }
1122
- /**
1123
- * Parse result.
1124
- */
1125
- export declare class ParseResult {
1126
- /**
1127
- * Attribute type map
1128
- */
1129
- static attributeTypeMap: Array<{
1130
- name: string;
1131
- baseName: string;
1132
- type: string;
1133
- }>;
1134
- /**
1135
- * Returns attribute type map
1136
- */
1137
- static getAttributeTypeMap(): {
1138
- name: string;
1139
- baseName: string;
1140
- type: string;
1141
- }[];
1142
- /**
1143
- * Gets or sets the total number of the fields data.
1144
- */
1145
- count: number;
1146
- /**
1147
- * Collection of the data fields.
1148
- */
1149
- fieldsData: Array<FieldData>;
1150
- constructor(init?: Partial<ParseResult>);
1151
- }
1152
- /**
1153
- * Base options class.
1154
- */
1155
- export declare class ParserOptions {
1156
- /**
1157
- * Attribute type map
1158
- */
1159
- static attributeTypeMap: Array<{
1160
- name: string;
1161
- baseName: string;
1162
- type: string;
1163
- }>;
1164
- /**
1165
- * Returns attribute type map
1166
- */
1167
- static getAttributeTypeMap(): {
1168
- name: string;
1169
- baseName: string;
1170
- type: string;
1171
- }[];
1172
- /**
1173
- * Gets or sets the file information.
1174
- */
1175
- fileInfo: FileInfo;
1176
- /**
1177
- * Gets or sets the container item information.
1178
- */
1179
- containerItemInfo: ContainerItemInfo;
1180
- constructor(init?: Partial<ParserOptions>);
1181
- }
1182
- /**
1183
- * Class for rectangle position model.
1184
- */
1185
- export declare class Point {
1186
- /**
1187
- * Attribute type map
1188
- */
1189
- static attributeTypeMap: Array<{
1190
- name: string;
1191
- baseName: string;
1192
- type: string;
1193
- }>;
1194
- /**
1195
- * Returns attribute type map
1196
- */
1197
- static getAttributeTypeMap(): {
1198
- name: string;
1199
- baseName: string;
1200
- type: string;
1201
- }[];
1202
- /**
1203
- * Gets or sets the x-coordinate.
1204
- */
1205
- x: number;
1206
- /**
1207
- * Gets or sets the y-coordinate.
1208
- */
1209
- y: number;
1210
- constructor(init?: Partial<Point>);
1211
- }
1212
- /**
1213
- * Rectangular area on the page.
1214
- */
1215
- export declare class Rectangle {
1216
- /**
1217
- * Attribute type map
1218
- */
1219
- static attributeTypeMap: Array<{
1220
- name: string;
1221
- baseName: string;
1222
- type: string;
1223
- }>;
1224
- /**
1225
- * Returns attribute type map
1226
- */
1227
- static getAttributeTypeMap(): {
1228
- name: string;
1229
- baseName: string;
1230
- type: string;
1231
- }[];
1232
- /**
1233
- * Gets the coordinates of the upper-left corner of the rectangular area.
1234
- */
1235
- position: Point;
1236
- /**
1237
- * Gets or sets the size of the rectangle.
1238
- */
1239
- size: Size;
1240
- /**
1241
- * Gets or sets the coordinates.
1242
- */
1243
- coordinates: Coordinates;
1244
- constructor(init?: Partial<Rectangle>);
1245
- }
1246
- /**
1247
- * Represents a size of rectangular area.
1248
- */
1249
- export declare class Size {
1250
- /**
1251
- * Attribute type map
1252
- */
1253
- static attributeTypeMap: Array<{
1254
- name: string;
1255
- baseName: string;
1256
- type: string;
1257
- }>;
1258
- /**
1259
- * Returns attribute type map
1260
- */
1261
- static getAttributeTypeMap(): {
1262
- name: string;
1263
- baseName: string;
1264
- type: string;
1265
- }[];
1266
- /**
1267
- * Gets or sets the height.
1268
- */
1269
- height: number;
1270
- /**
1271
- * Gets or sets the width.
1272
- */
1273
- width: number;
1274
- constructor(init?: Partial<Size>);
1275
- }
1276
- /**
1277
- * Storage exists
1278
- */
1279
- export declare class StorageExist {
1280
- /**
1281
- * Attribute type map
1282
- */
1283
- static attributeTypeMap: Array<{
1284
- name: string;
1285
- baseName: string;
1286
- type: string;
1287
- }>;
1288
- /**
1289
- * Returns attribute type map
1290
- */
1291
- static getAttributeTypeMap(): {
1292
- name: string;
1293
- baseName: string;
1294
- type: string;
1295
- }[];
1296
- /**
1297
- * Shows that the storage exists.
1298
- */
1299
- exists: boolean;
1300
- constructor(init?: Partial<StorageExist>);
1301
- }
1302
- /**
1303
- * File or folder information
1304
- */
1305
- export declare class StorageFile {
1306
- /**
1307
- * Attribute type map
1308
- */
1309
- static attributeTypeMap: Array<{
1310
- name: string;
1311
- baseName: string;
1312
- type: string;
1313
- }>;
1314
- /**
1315
- * Returns attribute type map
1316
- */
1317
- static getAttributeTypeMap(): {
1318
- name: string;
1319
- baseName: string;
1320
- type: string;
1321
- }[];
1322
- /**
1323
- * File or folder name.
1324
- */
1325
- name: string;
1326
- /**
1327
- * True if it is a folder.
1328
- */
1329
- isFolder: boolean;
1330
- /**
1331
- * File or folder last modified DateTime.
1332
- */
1333
- modifiedDate: Date;
1334
- /**
1335
- * File or folder size.
1336
- */
1337
- size: number;
1338
- /**
1339
- * File or folder path.
1340
- */
1341
- path: string;
1342
- constructor(init?: Partial<StorageFile>);
1343
- }
1344
- /**
1345
- * Document template table
1346
- */
1347
- export declare class Table {
1348
- /**
1349
- * Attribute type map
1350
- */
1351
- static attributeTypeMap: Array<{
1352
- name: string;
1353
- baseName: string;
1354
- type: string;
1355
- }>;
1356
- /**
1357
- * Returns attribute type map
1358
- */
1359
- static getAttributeTypeMap(): {
1360
- name: string;
1361
- baseName: string;
1362
- type: string;
1363
- }[];
1364
- /**
1365
- * Gets or sets a unique template table name.
1366
- */
1367
- tableName: string;
1368
- /**
1369
- * The page index. An integer value that represents the index of the page where the template item is located; null if the template item is located on any page.
1370
- */
1371
- pageIndex: number;
1372
- /**
1373
- * Gets or sets the detector parameters. Provides parameters for the table detection algorithms.
1374
- */
1375
- detectorParameters: DetectorParameters;
1376
- /**
1377
- * Gets or sets the table layout. Provides the template table layout which is used by Table to define table position.
1378
- */
1379
- tableLayout: TableLayout;
1380
- constructor(init?: Partial<Table>);
1381
- }
1382
- /**
1383
- * Provides the template table layout which is used by Table to define table position.
1384
- */
1385
- export declare class TableLayout {
1386
- /**
1387
- * Attribute type map
1388
- */
1389
- static attributeTypeMap: Array<{
1390
- name: string;
1391
- baseName: string;
1392
- type: string;
1393
- }>;
1394
- /**
1395
- * Returns attribute type map
1396
- */
1397
- static getAttributeTypeMap(): {
1398
- name: string;
1399
- baseName: string;
1400
- type: string;
1401
- }[];
1402
- /**
1403
- * Gets or sets the table columns separators.
1404
- */
1405
- verticalSeparators: Array<number>;
1406
- /**
1407
- * Gets or sets the table rows separators.
1408
- */
1409
- horizontalSeparators: Array<number>;
1410
- constructor(init?: Partial<TableLayout>);
1411
- }
1412
- /**
1413
- * User-generated template to extract metadata from the document.
1414
- */
1415
- export declare class Template {
1416
- /**
1417
- * Attribute type map
1418
- */
1419
- static attributeTypeMap: Array<{
1420
- name: string;
1421
- baseName: string;
1422
- type: string;
1423
- }>;
1424
- /**
1425
- * Returns attribute type map
1426
- */
1427
- static getAttributeTypeMap(): {
1428
- name: string;
1429
- baseName: string;
1430
- type: string;
1431
- }[];
1432
- /**
1433
- * Template fields.
1434
- */
1435
- fields: Array<Field>;
1436
- /**
1437
- * Template tables.
1438
- */
1439
- tables: Array<Table>;
1440
- constructor(init?: Partial<Template>);
1441
- }
1442
- /**
1443
- * Template methods options.
1444
- */
1445
- export declare class TemplateOptions {
1446
- /**
1447
- * Attribute type map
1448
- */
1449
- static attributeTypeMap: Array<{
1450
- name: string;
1451
- baseName: string;
1452
- type: string;
1453
- }>;
1454
- /**
1455
- * Returns attribute type map
1456
- */
1457
- static getAttributeTypeMap(): {
1458
- name: string;
1459
- baseName: string;
1460
- type: string;
1461
- }[];
1462
- /**
1463
- * Gets or sets the template path.
1464
- */
1465
- templatePath: string;
1466
- /**
1467
- * Gets or sets the name of the storage.
1468
- */
1469
- storageName: string;
1470
- constructor(init?: Partial<TemplateOptions>);
1471
- }
1472
- /**
1473
- * Document template result.
1474
- */
1475
- export declare class TemplateResult {
1476
- /**
1477
- * Attribute type map
1478
- */
1479
- static attributeTypeMap: Array<{
1480
- name: string;
1481
- baseName: string;
1482
- type: string;
1483
- }>;
1484
- /**
1485
- * Returns attribute type map
1486
- */
1487
- static getAttributeTypeMap(): {
1488
- name: string;
1489
- baseName: string;
1490
- type: string;
1491
- }[];
1492
- /**
1493
- * Gets or sets the template download URL.
1494
- */
1495
- url: string;
1496
- /**
1497
- * Gets or sets the path of the template, located in the storage.
1498
- */
1499
- templatePath: string;
1500
- constructor(init?: Partial<TemplateResult>);
1501
- }
1502
- /**
1503
- * Extracted text page class.
1504
- */
1505
- export declare class TextPage {
1506
- /**
1507
- * Attribute type map
1508
- */
1509
- static attributeTypeMap: Array<{
1510
- name: string;
1511
- baseName: string;
1512
- type: string;
1513
- }>;
1514
- /**
1515
- * Returns attribute type map
1516
- */
1517
- static getAttributeTypeMap(): {
1518
- name: string;
1519
- baseName: string;
1520
- type: string;
1521
- }[];
1522
- /**
1523
- * Gets or sets the pageIndex.
1524
- */
1525
- pageIndex: number;
1526
- /**
1527
- * Gets or sets the text.
1528
- */
1529
- text: string;
1530
- constructor(init?: Partial<TextPage>);
1531
- }
1532
- /**
1533
- * The result od text extraction.
1534
- */
1535
- export declare class TextResult {
1536
- /**
1537
- * Attribute type map
1538
- */
1539
- static attributeTypeMap: Array<{
1540
- name: string;
1541
- baseName: string;
1542
- type: string;
1543
- }>;
1544
- /**
1545
- * Returns attribute type map
1546
- */
1547
- static getAttributeTypeMap(): {
1548
- name: string;
1549
- baseName: string;
1550
- type: string;
1551
- }[];
1552
- /**
1553
- * Gets or sets the pages.
1554
- */
1555
- pages: Array<TextPage>;
1556
- /**
1557
- * Gets or sets the text.
1558
- */
1559
- text: string;
1560
- constructor(init?: Partial<TextResult>);
1561
- }
1562
- /**
1563
- * The text style such as font size, font name an so on.
1564
- */
1565
- export declare class TextStyle {
1566
- /**
1567
- * Attribute type map
1568
- */
1569
- static attributeTypeMap: Array<{
1570
- name: string;
1571
- baseName: string;
1572
- type: string;
1573
- }>;
1574
- /**
1575
- * Returns attribute type map
1576
- */
1577
- static getAttributeTypeMap(): {
1578
- name: string;
1579
- baseName: string;
1580
- type: string;
1581
- }[];
1582
- /**
1583
- * Gets or sets the name of the font.
1584
- */
1585
- fontName: string;
1586
- /**
1587
- * Gets or sets the size of the font.
1588
- */
1589
- fontSize: number;
1590
- /**
1591
- * Gets or sets the value that indicates whether the font is bold.
1592
- */
1593
- isBold: boolean;
1594
- /**
1595
- * Gets or sets the value that indicates whether the font is italic.
1596
- */
1597
- isItalic: boolean;
1598
- /**
1599
- * Gets or sets the style name.
1600
- */
1601
- name: string;
1602
- constructor(init?: Partial<TextStyle>);
1603
- }
1604
- /**
1605
- * Barcode options.
1606
- */
1607
- export declare class BarcodesOptions extends ParserOptions {
1608
- /**
1609
- * Attribute type map
1610
- */
1611
- static attributeTypeMap: Array<{
1612
- name: string;
1613
- baseName: string;
1614
- type: string;
1615
- }>;
1616
- /**
1617
- * Returns attribute type map
1618
- */
1619
- static getAttributeTypeMap(): {
1620
- name: string;
1621
- baseName: string;
1622
- type: string;
1623
- }[];
1624
- /**
1625
- * Gets or sets the output path for extracted barcodes.
1626
- */
1627
- outputPath: string;
1628
- /**
1629
- * Gets or sets the zero-based start page index.
1630
- */
1631
- startPageNumber: number;
1632
- /**
1633
- * Gets or sets the number of pages to extract.
1634
- */
1635
- countPagesToExtract: number;
1636
- constructor(init?: Partial<BarcodesOptions>);
1637
- }
1638
- /**
1639
- * Container options.
1640
- */
1641
- export declare class ContainerOptions extends ParserOptions {
1642
- /**
1643
- * Attribute type map
1644
- */
1645
- static attributeTypeMap: Array<{
1646
- name: string;
1647
- baseName: string;
1648
- type: string;
1649
- }>;
1650
- /**
1651
- * Returns attribute type map
1652
- */
1653
- static getAttributeTypeMap(): {
1654
- name: string;
1655
- baseName: string;
1656
- type: string;
1657
- }[];
1658
- constructor(init?: Partial<ContainerOptions>);
1659
- }
1660
- /**
1661
- * File Version
1662
- */
1663
- export declare class FileVersion extends StorageFile {
1664
- /**
1665
- * Attribute type map
1666
- */
1667
- static attributeTypeMap: Array<{
1668
- name: string;
1669
- baseName: string;
1670
- type: string;
1671
- }>;
1672
- /**
1673
- * Returns attribute type map
1674
- */
1675
- static getAttributeTypeMap(): {
1676
- name: string;
1677
- baseName: string;
1678
- type: string;
1679
- }[];
1680
- /**
1681
- * File Version ID.
1682
- */
1683
- versionId: string;
1684
- /**
1685
- * Specifies whether the file is (true) or is not (false) the latest version of an file.
1686
- */
1687
- isLatest: boolean;
1688
- constructor(init?: Partial<FileVersion>);
1689
- }
1690
- /**
1691
- * Image options.
1692
- */
1693
- export declare class ImagesOptions extends ParserOptions {
1694
- /**
1695
- * Attribute type map
1696
- */
1697
- static attributeTypeMap: Array<{
1698
- name: string;
1699
- baseName: string;
1700
- type: string;
1701
- }>;
1702
- /**
1703
- * Returns attribute type map
1704
- */
1705
- static getAttributeTypeMap(): {
1706
- name: string;
1707
- baseName: string;
1708
- type: string;
1709
- }[];
1710
- /**
1711
- * Gets or sets the output path for extracted images.
1712
- */
1713
- outputPath: string;
1714
- /**
1715
- * Gets or sets the zero-based start page index.
1716
- */
1717
- startPageNumber: number;
1718
- /**
1719
- * Gets or sets the number of pages to extract.
1720
- */
1721
- countPagesToExtract: number;
1722
- constructor(init?: Partial<ImagesOptions>);
1723
- }
1724
- /**
1725
- * Info options
1726
- */
1727
- export declare class InfoOptions extends ParserOptions {
1728
- /**
1729
- * Attribute type map
1730
- */
1731
- static attributeTypeMap: Array<{
1732
- name: string;
1733
- baseName: string;
1734
- type: string;
1735
- }>;
1736
- /**
1737
- * Returns attribute type map
1738
- */
1739
- static getAttributeTypeMap(): {
1740
- name: string;
1741
- baseName: string;
1742
- type: string;
1743
- }[];
1744
- constructor(init?: Partial<InfoOptions>);
1745
- }
1746
- /**
1747
- * Parse options.
1748
- */
1749
- export declare class ParseOptions extends ParserOptions {
1750
- /**
1751
- * Attribute type map
1752
- */
1753
- static attributeTypeMap: Array<{
1754
- name: string;
1755
- baseName: string;
1756
- type: string;
1757
- }>;
1758
- /**
1759
- * Returns attribute type map
1760
- */
1761
- static getAttributeTypeMap(): {
1762
- name: string;
1763
- baseName: string;
1764
- type: string;
1765
- }[];
1766
- /**
1767
- * User-generated template to extract metadata from the document.
1768
- */
1769
- template: Template;
1770
- /**
1771
- * The path of the file, located in the storage, which contains a user-generated template to parse data. Is used when the Template parameter is not provided.
1772
- */
1773
- templatePath: string;
1774
- constructor(init?: Partial<ParseOptions>);
1775
- }
1776
- /**
1777
- * Extract options.
1778
- */
1779
- export declare class TextOptions extends ParserOptions {
1780
- /**
1781
- * Attribute type map
1782
- */
1783
- static attributeTypeMap: Array<{
1784
- name: string;
1785
- baseName: string;
1786
- type: string;
1787
- }>;
1788
- /**
1789
- * Returns attribute type map
1790
- */
1791
- static getAttributeTypeMap(): {
1792
- name: string;
1793
- baseName: string;
1794
- type: string;
1795
- }[];
1796
- /**
1797
- * Gets or sets the options which are used for formatted text extraction.
1798
- */
1799
- formattedTextOptions: FormattedTextOptions;
1800
- /**
1801
- * Gets or sets the zero-based start page index.
1802
- */
1803
- startPageNumber: number;
1804
- /**
1805
- * Gets or sets the number of pages to extract.
1806
- */
1807
- countPagesToExtract: number;
1808
- constructor(init?: Partial<TextOptions>);
1809
- }
1810
- declare const enumsMap: {};
1811
- declare const typeMap: {
1812
- Barcode: typeof Barcode;
1813
- BarcodePage: typeof BarcodePage;
1814
- BarcodesResult: typeof BarcodesResult;
1815
- ContainerItem: typeof ContainerItem;
1816
- ContainerItemInfo: typeof ContainerItemInfo;
1817
- ContainerResult: typeof ContainerResult;
1818
- Coordinates: typeof Coordinates;
1819
- CreateTemplateOptions: typeof CreateTemplateOptions;
1820
- DetectorParameters: typeof DetectorParameters;
1821
- DiscUsage: typeof DiscUsage;
1822
- ErrorDetails: typeof ErrorDetails;
1823
- Field: typeof Field;
1824
- FieldData: typeof FieldData;
1825
- FieldPosition: typeof FieldPosition;
1826
- FileInfo: typeof FileInfo;
1827
- FileType: typeof FileType;
1828
- FileVersions: typeof FileVersions;
1829
- FilesList: typeof FilesList;
1830
- FilesUploadResult: typeof FilesUploadResult;
1831
- Format: typeof Format;
1832
- FormatsResult: typeof FormatsResult;
1833
- FormattedTextOptions: typeof FormattedTextOptions;
1834
- Image: typeof Image;
1835
- ImagePage: typeof ImagePage;
1836
- ImagesResult: typeof ImagesResult;
1837
- InfoResult: typeof InfoResult;
1838
- ModelError: typeof ModelError;
1839
- ObjectExist: typeof ObjectExist;
1840
- Page: typeof Page;
1841
- PageArea: typeof PageArea;
1842
- PageTableArea: typeof PageTableArea;
1843
- PageTableAreaCell: typeof PageTableAreaCell;
1844
- PageTextArea: typeof PageTextArea;
1845
- ParseResult: typeof ParseResult;
1846
- ParserOptions: typeof ParserOptions;
1847
- Point: typeof Point;
1848
- Rectangle: typeof Rectangle;
1849
- Size: typeof Size;
1850
- StorageExist: typeof StorageExist;
1851
- StorageFile: typeof StorageFile;
1852
- Table: typeof Table;
1853
- TableLayout: typeof TableLayout;
1854
- Template: typeof Template;
1855
- TemplateOptions: typeof TemplateOptions;
1856
- TemplateResult: typeof TemplateResult;
1857
- TextPage: typeof TextPage;
1858
- TextResult: typeof TextResult;
1859
- TextStyle: typeof TextStyle;
1860
- BarcodesOptions: typeof BarcodesOptions;
1861
- ContainerOptions: typeof ContainerOptions;
1862
- FileVersion: typeof FileVersion;
1863
- ImagesOptions: typeof ImagesOptions;
1864
- InfoOptions: typeof InfoOptions;
1865
- ParseOptions: typeof ParseOptions;
1866
- TextOptions: typeof TextOptions;
1867
- };
1868
- export { enumsMap, typeMap };
1869
- /**
1870
- * Request model for CopyFile operation.
1871
- */
1872
- export declare class CopyFileRequest {
1873
- /**
1874
- * Source file path e.g. '/folder/file.ext'
1875
- */
1876
- srcPath: string;
1877
- /**
1878
- * Destination file path
1879
- */
1880
- destPath: string;
1881
- /**
1882
- * Source storage name
1883
- */
1884
- srcStorageName: string;
1885
- /**
1886
- * Destination storage name
1887
- */
1888
- destStorageName: string;
1889
- /**
1890
- * File version ID to copy
1891
- */
1892
- versionId: string;
1893
- constructor(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string, versionId?: string);
1894
- }
1895
- /**
1896
- * Request model for DeleteFile operation.
1897
- */
1898
- export declare class DeleteFileRequest {
1899
- /**
1900
- * File path e.g. '/folder/file.ext'
1901
- */
1902
- path: string;
1903
- /**
1904
- * Storage name
1905
- */
1906
- storageName: string;
1907
- /**
1908
- * File version ID to delete
1909
- */
1910
- versionId: string;
1911
- constructor(path: string, storageName?: string, versionId?: string);
1912
- }
1913
- /**
1914
- * Request model for DownloadFile operation.
1915
- */
1916
- export declare class DownloadFileRequest {
1917
- /**
1918
- * File path e.g. '/folder/file.ext'
1919
- */
1920
- path: string;
1921
- /**
1922
- * Storage name
1923
- */
1924
- storageName: string;
1925
- /**
1926
- * File version ID to download
1927
- */
1928
- versionId: string;
1929
- constructor(path: string, storageName?: string, versionId?: string);
1930
- }
1931
- /**
1932
- * Request model for MoveFile operation.
1933
- */
1934
- export declare class MoveFileRequest {
1935
- /**
1936
- * Source file path e.g. '/src.ext'
1937
- */
1938
- srcPath: string;
1939
- /**
1940
- * Destination file path e.g. '/dest.ext'
1941
- */
1942
- destPath: string;
1943
- /**
1944
- * Source storage name
1945
- */
1946
- srcStorageName: string;
1947
- /**
1948
- * Destination storage name
1949
- */
1950
- destStorageName: string;
1951
- /**
1952
- * File version ID to move
1953
- */
1954
- versionId: string;
1955
- constructor(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string, versionId?: string);
1956
- }
1957
- /**
1958
- * Request model for UploadFile operation.
1959
- */
1960
- export declare class UploadFileRequest {
1961
- /**
1962
- * Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header.
1963
- */
1964
- path: string;
1965
- /**
1966
- * File to upload
1967
- */
1968
- file: Buffer;
1969
- /**
1970
- * Storage name
1971
- */
1972
- storageName: string;
1973
- constructor(path: string, file: Buffer, storageName?: string);
1974
- }
1975
- /**
1976
- * Request model for CopyFolder operation.
1977
- */
1978
- export declare class CopyFolderRequest {
1979
- /**
1980
- * Source folder path e.g. '/src'
1981
- */
1982
- srcPath: string;
1983
- /**
1984
- * Destination folder path e.g. '/dst'
1985
- */
1986
- destPath: string;
1987
- /**
1988
- * Source storage name
1989
- */
1990
- srcStorageName: string;
1991
- /**
1992
- * Destination storage name
1993
- */
1994
- destStorageName: string;
1995
- constructor(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string);
1996
- }
1997
- /**
1998
- * Request model for CreateFolder operation.
1999
- */
2000
- export declare class CreateFolderRequest {
2001
- /**
2002
- * Folder path to create e.g. 'folder_1/folder_2/'
2003
- */
2004
- path: string;
2005
- /**
2006
- * Storage name
2007
- */
2008
- storageName: string;
2009
- constructor(path: string, storageName?: string);
2010
- }
2011
- /**
2012
- * Request model for DeleteFolder operation.
2013
- */
2014
- export declare class DeleteFolderRequest {
2015
- /**
2016
- * Folder path e.g. '/folder'
2017
- */
2018
- path: string;
2019
- /**
2020
- * Storage name
2021
- */
2022
- storageName: string;
2023
- /**
2024
- * Enable to delete folders, subfolders and files
2025
- */
2026
- recursive: boolean;
2027
- constructor(path: string, storageName?: string, recursive?: boolean);
2028
- }
2029
- /**
2030
- * Request model for GetFilesList operation.
2031
- */
2032
- export declare class GetFilesListRequest {
2033
- /**
2034
- * Folder path e.g. '/folder'
2035
- */
2036
- path: string;
2037
- /**
2038
- * Storage name
2039
- */
2040
- storageName: string;
2041
- constructor(path: string, storageName?: string);
2042
- }
2043
- /**
2044
- * Request model for MoveFolder operation.
2045
- */
2046
- export declare class MoveFolderRequest {
2047
- /**
2048
- * Folder path to move e.g. '/folder'
2049
- */
2050
- srcPath: string;
2051
- /**
2052
- * Destination folder path to move to e.g '/dst'
2053
- */
2054
- destPath: string;
2055
- /**
2056
- * Source storage name
2057
- */
2058
- srcStorageName: string;
2059
- /**
2060
- * Destination storage name
2061
- */
2062
- destStorageName: string;
2063
- constructor(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string);
2064
- }
2065
- /**
2066
- * Request model for Container operation.
2067
- */
2068
- export declare class ContainerRequest {
2069
- /**
2070
- * Container options.
2071
- */
2072
- options: ContainerOptions;
2073
- constructor(options: ContainerOptions);
2074
- }
2075
- /**
2076
- * Request model for GetInfo operation.
2077
- */
2078
- export declare class GetInfoRequest {
2079
- /**
2080
- * Info options.
2081
- */
2082
- options: InfoOptions;
2083
- constructor(options: InfoOptions);
2084
- }
2085
- /**
2086
- * Request model for Barcodes operation.
2087
- */
2088
- export declare class BarcodesRequest {
2089
- /**
2090
- * Extract barcode options.
2091
- */
2092
- options: BarcodesOptions;
2093
- constructor(options: BarcodesOptions);
2094
- }
2095
- /**
2096
- * Request model for Images operation.
2097
- */
2098
- export declare class ImagesRequest {
2099
- /**
2100
- * Extract image options.
2101
- */
2102
- options: ImagesOptions;
2103
- constructor(options: ImagesOptions);
2104
- }
2105
- /**
2106
- * Request model for Parse operation.
2107
- */
2108
- export declare class ParseRequest {
2109
- /**
2110
- * Parse options.
2111
- */
2112
- options: ParseOptions;
2113
- constructor(options: ParseOptions);
2114
- }
2115
- /**
2116
- * Request model for Text operation.
2117
- */
2118
- export declare class TextRequest {
2119
- /**
2120
- * Extract text options.
2121
- */
2122
- options: TextOptions;
2123
- constructor(options: TextOptions);
2124
- }
2125
- /**
2126
- * Request model for GetDiscUsage operation.
2127
- */
2128
- export declare class GetDiscUsageRequest {
2129
- /**
2130
- * Storage name
2131
- */
2132
- storageName: string;
2133
- constructor(storageName?: string);
2134
- }
2135
- /**
2136
- * Request model for GetFileVersions operation.
2137
- */
2138
- export declare class GetFileVersionsRequest {
2139
- /**
2140
- * File path e.g. '/file.ext'
2141
- */
2142
- path: string;
2143
- /**
2144
- * Storage name
2145
- */
2146
- storageName: string;
2147
- constructor(path: string, storageName?: string);
2148
- }
2149
- /**
2150
- * Request model for ObjectExists operation.
2151
- */
2152
- export declare class ObjectExistsRequest {
2153
- /**
2154
- * File or folder path e.g. '/file.ext' or '/folder'
2155
- */
2156
- path: string;
2157
- /**
2158
- * Storage name
2159
- */
2160
- storageName: string;
2161
- /**
2162
- * File version ID
2163
- */
2164
- versionId: string;
2165
- constructor(path: string, storageName?: string, versionId?: string);
2166
- }
2167
- /**
2168
- * Request model for StorageExists operation.
2169
- */
2170
- export declare class StorageExistsRequest {
2171
- /**
2172
- * Storage name
2173
- */
2174
- storageName: string;
2175
- constructor(storageName: string);
2176
- }
2177
- /**
2178
- * Request model for CreateTemplate operation.
2179
- */
2180
- export declare class CreateTemplateRequest {
2181
- /**
2182
- * Create template options.
2183
- */
2184
- options: CreateTemplateOptions;
2185
- constructor(options: CreateTemplateOptions);
2186
- }
2187
- /**
2188
- * Request model for DeleteTemplate operation.
2189
- */
2190
- export declare class DeleteTemplateRequest {
2191
- /**
2192
- * Delete template options.
2193
- */
2194
- options: TemplateOptions;
2195
- constructor(options: TemplateOptions);
2196
- }
2197
- /**
2198
- * Request model for GetTemplate operation.
2199
- */
2200
- export declare class GetTemplateRequest {
2201
- /**
2202
- * Retrieve template options.
2203
- */
2204
- options: TemplateOptions;
2205
- constructor(options: TemplateOptions);
2206
- }
1
+ /**
2
+ * Represents an barcode.
3
+ */
4
+ export declare class Barcode {
5
+ /**
6
+ * Attribute type map
7
+ */
8
+ static attributeTypeMap: Array<{
9
+ name: string;
10
+ baseName: string;
11
+ type: string;
12
+ }>;
13
+ /**
14
+ * Returns attribute type map
15
+ */
16
+ static getAttributeTypeMap(): {
17
+ name: string;
18
+ baseName: string;
19
+ type: string;
20
+ }[];
21
+ /**
22
+ * Gets the name of the barcode type.
23
+ */
24
+ codeTypeName: string;
25
+ /**
26
+ * Gets the document page information such as page index and page size.
27
+ */
28
+ page: BarcodePage;
29
+ /**
30
+ * Gets the rectangular area.
31
+ */
32
+ rectangle: Rectangle;
33
+ /**
34
+ * Gets the barcode value.
35
+ */
36
+ value: string;
37
+ /**
38
+ * Gets or sets the barcode download URL.
39
+ */
40
+ downloadUrl: string;
41
+ constructor(init?: Partial<Barcode>);
42
+ }
43
+ export declare class BarcodePage {
44
+ /**
45
+ * Attribute type map
46
+ */
47
+ static attributeTypeMap: Array<{
48
+ name: string;
49
+ baseName: string;
50
+ type: string;
51
+ }>;
52
+ /**
53
+ * Returns attribute type map
54
+ */
55
+ static getAttributeTypeMap(): {
56
+ name: string;
57
+ baseName: string;
58
+ type: string;
59
+ }[];
60
+ /**
61
+ * Gets the page index.
62
+ */
63
+ index: number;
64
+ /**
65
+ * Gets the page size.
66
+ */
67
+ size: Size;
68
+ constructor(init?: Partial<BarcodePage>);
69
+ }
70
+ export declare class BarcodesResult {
71
+ /**
72
+ * Attribute type map
73
+ */
74
+ static attributeTypeMap: Array<{
75
+ name: string;
76
+ baseName: string;
77
+ type: string;
78
+ }>;
79
+ /**
80
+ * Returns attribute type map
81
+ */
82
+ static getAttributeTypeMap(): {
83
+ name: string;
84
+ baseName: string;
85
+ type: string;
86
+ }[];
87
+ /**
88
+ * Gets or sets a collection of barcodes.
89
+ */
90
+ barcodes: Array<Barcode>;
91
+ constructor(init?: Partial<BarcodesResult>);
92
+ }
93
+ /**
94
+ * Represents a container item like Zip archive entity, email attachment, PDF Portfolio item and so on.
95
+ */
96
+ export declare class ContainerItem {
97
+ /**
98
+ * Attribute type map
99
+ */
100
+ static attributeTypeMap: Array<{
101
+ name: string;
102
+ baseName: string;
103
+ type: string;
104
+ }>;
105
+ /**
106
+ * Returns attribute type map
107
+ */
108
+ static getAttributeTypeMap(): {
109
+ name: string;
110
+ baseName: string;
111
+ type: string;
112
+ }[];
113
+ /**
114
+ * Gets or sets the name of the item.
115
+ */
116
+ name: string;
117
+ /**
118
+ * Gets or sets the full path of the item.
119
+ */
120
+ filePath: string;
121
+ /**
122
+ * Gets or sets the directory of the item.
123
+ */
124
+ directory: string;
125
+ /**
126
+ * Gets or sets the collection of metadata items.
127
+ */
128
+ metadata: {
129
+ [key: string]: string;
130
+ };
131
+ constructor(init?: Partial<ContainerItem>);
132
+ }
133
+ /**
134
+ * Container item info.
135
+ */
136
+ export declare class ContainerItemInfo {
137
+ /**
138
+ * Attribute type map
139
+ */
140
+ static attributeTypeMap: Array<{
141
+ name: string;
142
+ baseName: string;
143
+ type: string;
144
+ }>;
145
+ /**
146
+ * Returns attribute type map
147
+ */
148
+ static getAttributeTypeMap(): {
149
+ name: string;
150
+ baseName: string;
151
+ type: string;
152
+ }[];
153
+ /**
154
+ * The relative path of the container.
155
+ */
156
+ relativePath: string;
157
+ /**
158
+ * Password for processing password-protected container item.
159
+ */
160
+ password: string;
161
+ constructor(init?: Partial<ContainerItemInfo>);
162
+ }
163
+ /**
164
+ * Container result.
165
+ */
166
+ export declare class ContainerResult {
167
+ /**
168
+ * Attribute type map
169
+ */
170
+ static attributeTypeMap: Array<{
171
+ name: string;
172
+ baseName: string;
173
+ type: string;
174
+ }>;
175
+ /**
176
+ * Returns attribute type map
177
+ */
178
+ static getAttributeTypeMap(): {
179
+ name: string;
180
+ baseName: string;
181
+ type: string;
182
+ }[];
183
+ /**
184
+ * Gets or sets the collection of a container items like Zip archive entity, email attachment, PDF Portfolio item and so on.
185
+ */
186
+ containerItems: Array<ContainerItem>;
187
+ constructor(init?: Partial<ContainerResult>);
188
+ }
189
+ /**
190
+ * Class for rectangle coordinates.
191
+ */
192
+ export declare class Coordinates {
193
+ /**
194
+ * Attribute type map
195
+ */
196
+ static attributeTypeMap: Array<{
197
+ name: string;
198
+ baseName: string;
199
+ type: string;
200
+ }>;
201
+ /**
202
+ * Returns attribute type map
203
+ */
204
+ static getAttributeTypeMap(): {
205
+ name: string;
206
+ baseName: string;
207
+ type: string;
208
+ }[];
209
+ /**
210
+ * Gets or sets the y-coordinate of the top edge of the rectangular area.
211
+ */
212
+ top: number;
213
+ /**
214
+ * Gets or sets the y-coordinate of the bottom edge of the rectangular area.
215
+ */
216
+ bottom: number;
217
+ /**
218
+ * Gets or sets the x-coordinate of the left edge of the rectangular area.
219
+ */
220
+ left: number;
221
+ /**
222
+ * Gets or sets the x-coordinate of the right edge of the rectangular area.
223
+ */
224
+ right: number;
225
+ constructor(init?: Partial<Coordinates>);
226
+ }
227
+ /**
228
+ * Template methods options.
229
+ */
230
+ export declare class CreateTemplateOptions {
231
+ /**
232
+ * Attribute type map
233
+ */
234
+ static attributeTypeMap: Array<{
235
+ name: string;
236
+ baseName: string;
237
+ type: string;
238
+ }>;
239
+ /**
240
+ * Returns attribute type map
241
+ */
242
+ static getAttributeTypeMap(): {
243
+ name: string;
244
+ baseName: string;
245
+ type: string;
246
+ }[];
247
+ /**
248
+ * Gets or sets the template.
249
+ */
250
+ template: Template;
251
+ /**
252
+ * Gets or sets the template path.
253
+ */
254
+ templatePath: string;
255
+ /**
256
+ * Gets or sets the name of the storage.
257
+ */
258
+ storageName: string;
259
+ constructor(init?: Partial<CreateTemplateOptions>);
260
+ }
261
+ /**
262
+ * Provides parameters for the table detection algorithms.
263
+ */
264
+ export declare class DetectorParameters {
265
+ /**
266
+ * Attribute type map
267
+ */
268
+ static attributeTypeMap: Array<{
269
+ name: string;
270
+ baseName: string;
271
+ type: string;
272
+ }>;
273
+ /**
274
+ * Returns attribute type map
275
+ */
276
+ static getAttributeTypeMap(): {
277
+ name: string;
278
+ baseName: string;
279
+ type: string;
280
+ }[];
281
+ /**
282
+ * Gets or sets the minimum number of the table rows.
283
+ */
284
+ minRowCount: number;
285
+ /**
286
+ * Gets or sets the minimum number of the table columns.
287
+ */
288
+ minColumnCount: number;
289
+ /**
290
+ * Gets or sets the minimum space between the table columns.
291
+ */
292
+ minVerticalSpace: number;
293
+ /**
294
+ * Gets or sets the value that indicates whether the table has merged cells.
295
+ */
296
+ hasMergedCells: boolean;
297
+ /**
298
+ * Gets or sets the rectangular area that contains the table.
299
+ */
300
+ rectangle: Rectangle;
301
+ /**
302
+ * Gets or sets the table columns separators.
303
+ */
304
+ verticalSeparators: Array<number>;
305
+ constructor(init?: Partial<DetectorParameters>);
306
+ }
307
+ /**
308
+ * Class for disc space information.
309
+ */
310
+ export declare class DiscUsage {
311
+ /**
312
+ * Attribute type map
313
+ */
314
+ static attributeTypeMap: Array<{
315
+ name: string;
316
+ baseName: string;
317
+ type: string;
318
+ }>;
319
+ /**
320
+ * Returns attribute type map
321
+ */
322
+ static getAttributeTypeMap(): {
323
+ name: string;
324
+ baseName: string;
325
+ type: string;
326
+ }[];
327
+ /**
328
+ * Application used disc space.
329
+ */
330
+ usedSize: number;
331
+ /**
332
+ * Total disc space.
333
+ */
334
+ totalSize: number;
335
+ constructor(init?: Partial<DiscUsage>);
336
+ }
337
+ /**
338
+ * The error details
339
+ */
340
+ export declare class ErrorDetails {
341
+ /**
342
+ * Attribute type map
343
+ */
344
+ static attributeTypeMap: Array<{
345
+ name: string;
346
+ baseName: string;
347
+ type: string;
348
+ }>;
349
+ /**
350
+ * Returns attribute type map
351
+ */
352
+ static getAttributeTypeMap(): {
353
+ name: string;
354
+ baseName: string;
355
+ type: string;
356
+ }[];
357
+ /**
358
+ * The request id
359
+ */
360
+ requestId: string;
361
+ /**
362
+ * Date
363
+ */
364
+ date: Date;
365
+ constructor(init?: Partial<ErrorDetails>);
366
+ }
367
+ /**
368
+ * Field of document template
369
+ */
370
+ export declare class Field {
371
+ /**
372
+ * Attribute type map
373
+ */
374
+ static attributeTypeMap: Array<{
375
+ name: string;
376
+ baseName: string;
377
+ type: string;
378
+ }>;
379
+ /**
380
+ * Returns attribute type map
381
+ */
382
+ static getAttributeTypeMap(): {
383
+ name: string;
384
+ baseName: string;
385
+ type: string;
386
+ }[];
387
+ /**
388
+ * A unique template field name.
389
+ */
390
+ fieldName: string;
391
+ /**
392
+ * The page index. An integer value that represents the index of the page where the template item is located; null if the template item is located on any page.
393
+ */
394
+ pageIndex: number;
395
+ /**
396
+ * Defines the way how to find the field on a page.
397
+ */
398
+ fieldPosition: FieldPosition;
399
+ constructor(init?: Partial<Field>);
400
+ }
401
+ /**
402
+ * Class for document field data.
403
+ */
404
+ export declare class FieldData {
405
+ /**
406
+ * Attribute type map
407
+ */
408
+ static attributeTypeMap: Array<{
409
+ name: string;
410
+ baseName: string;
411
+ type: string;
412
+ }>;
413
+ /**
414
+ * Returns attribute type map
415
+ */
416
+ static getAttributeTypeMap(): {
417
+ name: string;
418
+ baseName: string;
419
+ type: string;
420
+ }[];
421
+ /**
422
+ * Gets or sets the field name.
423
+ */
424
+ name: string;
425
+ /**
426
+ * Gets or sets the index of the page.
427
+ */
428
+ pageIndex: number;
429
+ /**
430
+ * Gets or sets the value of the field.
431
+ */
432
+ pageArea: PageArea;
433
+ /**
434
+ * Gets or sets the linked data field.
435
+ */
436
+ linkedField: FieldData;
437
+ constructor(init?: Partial<FieldData>);
438
+ }
439
+ /**
440
+ * Field position class.
441
+ */
442
+ export declare class FieldPosition {
443
+ /**
444
+ * Attribute type map
445
+ */
446
+ static attributeTypeMap: Array<{
447
+ name: string;
448
+ baseName: string;
449
+ type: string;
450
+ }>;
451
+ /**
452
+ * Returns attribute type map
453
+ */
454
+ static getAttributeTypeMap(): {
455
+ name: string;
456
+ baseName: string;
457
+ type: string;
458
+ }[];
459
+ /**
460
+ * Provides a template field position.
461
+ */
462
+ fieldPositionType: string;
463
+ /**
464
+ * Rectangular area on the page that bounds the field value.
465
+ */
466
+ rectangle: Rectangle;
467
+ /**
468
+ * Gets or sets the regular expression.
469
+ */
470
+ regex: string;
471
+ /**
472
+ * Gets or sets the value that indicates whether a text case isn't ignored.
473
+ */
474
+ matchCase: boolean;
475
+ /**
476
+ * Gets or sets the name of the linked field.
477
+ */
478
+ linkedFieldName: string;
479
+ /**
480
+ * Gets or sets the value that indicates whether a field is searched by the left from the linked field.
481
+ */
482
+ isLeftLinked: boolean;
483
+ /**
484
+ * Gets or sets a value indicating whether this instance is right linked.
485
+ */
486
+ isRightLinked: boolean;
487
+ /**
488
+ * Gets or sets a value indicating whether this instance is top linked.
489
+ */
490
+ isTopLinked: boolean;
491
+ /**
492
+ * Gets or sets a value indicating whether this instance is bottom linked.
493
+ */
494
+ isBottomLinked: boolean;
495
+ /**
496
+ * Gets or sets the size of the area where a field is searched.
497
+ */
498
+ searchArea: Size;
499
+ /**
500
+ * Gets or sets Gets the value that indicates whether SearchArea is scaled by the linked field size.
501
+ */
502
+ autoScale: boolean;
503
+ constructor(init?: Partial<FieldPosition>);
504
+ }
505
+ /**
506
+ * File info
507
+ */
508
+ export declare class FileInfo {
509
+ /**
510
+ * Attribute type map
511
+ */
512
+ static attributeTypeMap: Array<{
513
+ name: string;
514
+ baseName: string;
515
+ type: string;
516
+ }>;
517
+ /**
518
+ * Returns attribute type map
519
+ */
520
+ static getAttributeTypeMap(): {
521
+ name: string;
522
+ baseName: string;
523
+ type: string;
524
+ }[];
525
+ /**
526
+ * File path in storage
527
+ */
528
+ filePath: string;
529
+ /**
530
+ * Storage name
531
+ */
532
+ storageName: string;
533
+ /**
534
+ * Password to open file
535
+ */
536
+ password: string;
537
+ constructor(init?: Partial<FileInfo>);
538
+ }
539
+ /**
540
+ * Represents the file type.
541
+ */
542
+ export declare class FileType {
543
+ /**
544
+ * Attribute type map
545
+ */
546
+ static attributeTypeMap: Array<{
547
+ name: string;
548
+ baseName: string;
549
+ type: string;
550
+ }>;
551
+ /**
552
+ * Returns attribute type map
553
+ */
554
+ static getAttributeTypeMap(): {
555
+ name: string;
556
+ baseName: string;
557
+ type: string;
558
+ }[];
559
+ /**
560
+ * Gets or sets the file type name e.g. \"Microsoft Word Document\".
561
+ */
562
+ fileFormat: string;
563
+ /**
564
+ * Gets or sets the filename suffix (including the period \".\") e.g. \".doc\".
565
+ */
566
+ extension: string;
567
+ constructor(init?: Partial<FileType>);
568
+ }
569
+ /**
570
+ * File versions FileVersion.
571
+ */
572
+ export declare class FileVersions {
573
+ /**
574
+ * Attribute type map
575
+ */
576
+ static attributeTypeMap: Array<{
577
+ name: string;
578
+ baseName: string;
579
+ type: string;
580
+ }>;
581
+ /**
582
+ * Returns attribute type map
583
+ */
584
+ static getAttributeTypeMap(): {
585
+ name: string;
586
+ baseName: string;
587
+ type: string;
588
+ }[];
589
+ /**
590
+ * File versions FileVersion.
591
+ */
592
+ value: Array<FileVersion>;
593
+ constructor(init?: Partial<FileVersions>);
594
+ }
595
+ /**
596
+ * Files list
597
+ */
598
+ export declare class FilesList {
599
+ /**
600
+ * Attribute type map
601
+ */
602
+ static attributeTypeMap: Array<{
603
+ name: string;
604
+ baseName: string;
605
+ type: string;
606
+ }>;
607
+ /**
608
+ * Returns attribute type map
609
+ */
610
+ static getAttributeTypeMap(): {
611
+ name: string;
612
+ baseName: string;
613
+ type: string;
614
+ }[];
615
+ /**
616
+ * Files and folders contained by folder StorageFile.
617
+ */
618
+ value: Array<StorageFile>;
619
+ constructor(init?: Partial<FilesList>);
620
+ }
621
+ /**
622
+ * File upload result
623
+ */
624
+ export declare class FilesUploadResult {
625
+ /**
626
+ * Attribute type map
627
+ */
628
+ static attributeTypeMap: Array<{
629
+ name: string;
630
+ baseName: string;
631
+ type: string;
632
+ }>;
633
+ /**
634
+ * Returns attribute type map
635
+ */
636
+ static getAttributeTypeMap(): {
637
+ name: string;
638
+ baseName: string;
639
+ type: string;
640
+ }[];
641
+ /**
642
+ * List of uploaded file names
643
+ */
644
+ uploaded: Array<string>;
645
+ /**
646
+ * List of errors.
647
+ */
648
+ errors: Array<Error>;
649
+ constructor(init?: Partial<FilesUploadResult>);
650
+ }
651
+ /**
652
+ * File-format
653
+ */
654
+ export declare class Format {
655
+ /**
656
+ * Attribute type map
657
+ */
658
+ static attributeTypeMap: Array<{
659
+ name: string;
660
+ baseName: string;
661
+ type: string;
662
+ }>;
663
+ /**
664
+ * Returns attribute type map
665
+ */
666
+ static getAttributeTypeMap(): {
667
+ name: string;
668
+ baseName: string;
669
+ type: string;
670
+ }[];
671
+ /**
672
+ * File extension
673
+ */
674
+ extension: string;
675
+ /**
676
+ * File format
677
+ */
678
+ fileFormat: string;
679
+ constructor(init?: Partial<Format>);
680
+ }
681
+ /**
682
+ * Describes object which contains list of supported file formats.
683
+ */
684
+ export declare class FormatsResult {
685
+ /**
686
+ * Attribute type map
687
+ */
688
+ static attributeTypeMap: Array<{
689
+ name: string;
690
+ baseName: string;
691
+ type: string;
692
+ }>;
693
+ /**
694
+ * Returns attribute type map
695
+ */
696
+ static getAttributeTypeMap(): {
697
+ name: string;
698
+ baseName: string;
699
+ type: string;
700
+ }[];
701
+ /**
702
+ * Supported file formats.
703
+ */
704
+ formats: Array<Format>;
705
+ constructor(init?: Partial<FormatsResult>);
706
+ }
707
+ /**
708
+ * Provides the options which are used for formatted text extraction.
709
+ */
710
+ export declare class FormattedTextOptions {
711
+ /**
712
+ * Attribute type map
713
+ */
714
+ static attributeTypeMap: Array<{
715
+ name: string;
716
+ baseName: string;
717
+ type: string;
718
+ }>;
719
+ /**
720
+ * Returns attribute type map
721
+ */
722
+ static getAttributeTypeMap(): {
723
+ name: string;
724
+ baseName: string;
725
+ type: string;
726
+ }[];
727
+ /**
728
+ * Gets or sets the formatted text extraction mode.
729
+ */
730
+ mode: string;
731
+ constructor(init?: Partial<FormattedTextOptions>);
732
+ }
733
+ /**
734
+ * Represents an image.
735
+ */
736
+ export declare class Image {
737
+ /**
738
+ * Attribute type map
739
+ */
740
+ static attributeTypeMap: Array<{
741
+ name: string;
742
+ baseName: string;
743
+ type: string;
744
+ }>;
745
+ /**
746
+ * Returns attribute type map
747
+ */
748
+ static getAttributeTypeMap(): {
749
+ name: string;
750
+ baseName: string;
751
+ type: string;
752
+ }[];
753
+ /**
754
+ * Gets or sets The path of the image, located in the storage.
755
+ */
756
+ path: string;
757
+ /**
758
+ * Gets or sets the image download URL.
759
+ */
760
+ downloadUrl: string;
761
+ /**
762
+ * Gets or sets the index of the page.
763
+ */
764
+ pageIndex: number;
765
+ /**
766
+ * Gets or sets the rotation of the image in degrees.
767
+ */
768
+ rotation: number;
769
+ /**
770
+ * Gets or sets the image file format.
771
+ */
772
+ fileFormat: string;
773
+ /**
774
+ * Gets or sets the rectangle area of the image.
775
+ */
776
+ rectangle: Rectangle;
777
+ constructor(init?: Partial<Image>);
778
+ }
779
+ /**
780
+ * Represents page object with image collection.
781
+ */
782
+ export declare class ImagePage {
783
+ /**
784
+ * Attribute type map
785
+ */
786
+ static attributeTypeMap: Array<{
787
+ name: string;
788
+ baseName: string;
789
+ type: string;
790
+ }>;
791
+ /**
792
+ * Returns attribute type map
793
+ */
794
+ static getAttributeTypeMap(): {
795
+ name: string;
796
+ baseName: string;
797
+ type: string;
798
+ }[];
799
+ /**
800
+ * The index of the page.
801
+ */
802
+ pageIndex: number;
803
+ /**
804
+ * collection of the page images.
805
+ */
806
+ images: Array<Image>;
807
+ constructor(init?: Partial<ImagePage>);
808
+ }
809
+ /**
810
+ * Images result.
811
+ */
812
+ export declare class ImagesResult {
813
+ /**
814
+ * Attribute type map
815
+ */
816
+ static attributeTypeMap: Array<{
817
+ name: string;
818
+ baseName: string;
819
+ type: string;
820
+ }>;
821
+ /**
822
+ * Returns attribute type map
823
+ */
824
+ static getAttributeTypeMap(): {
825
+ name: string;
826
+ baseName: string;
827
+ type: string;
828
+ }[];
829
+ /**
830
+ * Gets or sets a collection of images.
831
+ */
832
+ images: Array<Image>;
833
+ /**
834
+ * Collection of the extracted pages with images.
835
+ */
836
+ pages: Array<ImagePage>;
837
+ constructor(init?: Partial<ImagesResult>);
838
+ }
839
+ /**
840
+ * Info result.
841
+ */
842
+ export declare class InfoResult {
843
+ /**
844
+ * Attribute type map
845
+ */
846
+ static attributeTypeMap: Array<{
847
+ name: string;
848
+ baseName: string;
849
+ type: string;
850
+ }>;
851
+ /**
852
+ * Returns attribute type map
853
+ */
854
+ static getAttributeTypeMap(): {
855
+ name: string;
856
+ baseName: string;
857
+ type: string;
858
+ }[];
859
+ /**
860
+ * Gets or sets the type of the file.
861
+ */
862
+ fileType: FileType;
863
+ /**
864
+ * Gets or sets the size of the document in bytes.
865
+ */
866
+ size: number;
867
+ /**
868
+ * Gets or sets the total number of document pages.
869
+ */
870
+ pageCount: number;
871
+ /**
872
+ * Gets or sets the encoding.
873
+ */
874
+ encoding: string;
875
+ constructor(init?: Partial<InfoResult>);
876
+ }
877
+ /**
878
+ * Error
879
+ */
880
+ export declare class ModelError {
881
+ /**
882
+ * Attribute type map
883
+ */
884
+ static attributeTypeMap: Array<{
885
+ name: string;
886
+ baseName: string;
887
+ type: string;
888
+ }>;
889
+ /**
890
+ * Returns attribute type map
891
+ */
892
+ static getAttributeTypeMap(): {
893
+ name: string;
894
+ baseName: string;
895
+ type: string;
896
+ }[];
897
+ /**
898
+ * Code
899
+ */
900
+ code: string;
901
+ /**
902
+ * Message
903
+ */
904
+ message: string;
905
+ /**
906
+ * Description
907
+ */
908
+ description: string;
909
+ /**
910
+ * Inner Error
911
+ */
912
+ innerError: ErrorDetails;
913
+ constructor(init?: Partial<ModelError>);
914
+ }
915
+ /**
916
+ * Object exists
917
+ */
918
+ export declare class ObjectExist {
919
+ /**
920
+ * Attribute type map
921
+ */
922
+ static attributeTypeMap: Array<{
923
+ name: string;
924
+ baseName: string;
925
+ type: string;
926
+ }>;
927
+ /**
928
+ * Returns attribute type map
929
+ */
930
+ static getAttributeTypeMap(): {
931
+ name: string;
932
+ baseName: string;
933
+ type: string;
934
+ }[];
935
+ /**
936
+ * Indicates that the file or folder exists.
937
+ */
938
+ exists: boolean;
939
+ /**
940
+ * True if it is a folder, false if it is a file.
941
+ */
942
+ isFolder: boolean;
943
+ constructor(init?: Partial<ObjectExist>);
944
+ }
945
+ /**
946
+ * The document page information such as page index and page size.
947
+ */
948
+ export declare class Page {
949
+ /**
950
+ * Attribute type map
951
+ */
952
+ static attributeTypeMap: Array<{
953
+ name: string;
954
+ baseName: string;
955
+ type: string;
956
+ }>;
957
+ /**
958
+ * Returns attribute type map
959
+ */
960
+ static getAttributeTypeMap(): {
961
+ name: string;
962
+ baseName: string;
963
+ type: string;
964
+ }[];
965
+ /**
966
+ * Gets or sets the index of the page.
967
+ */
968
+ index: number;
969
+ /**
970
+ * Gets or sets the size of the page.
971
+ */
972
+ size: Size;
973
+ constructor(init?: Partial<Page>);
974
+ }
975
+ /**
976
+ * Class for document page area.
977
+ */
978
+ export declare class PageArea {
979
+ /**
980
+ * Attribute type map
981
+ */
982
+ static attributeTypeMap: Array<{
983
+ name: string;
984
+ baseName: string;
985
+ type: string;
986
+ }>;
987
+ /**
988
+ * Returns attribute type map
989
+ */
990
+ static getAttributeTypeMap(): {
991
+ name: string;
992
+ baseName: string;
993
+ type: string;
994
+ }[];
995
+ /**
996
+ * Gets or sets the rectangular area.
997
+ */
998
+ rectangle: Rectangle;
999
+ /**
1000
+ * Gets or sets the document page information such as page index and page size.
1001
+ */
1002
+ page: Page;
1003
+ /**
1004
+ * Gets or sets the text area. Represents a page text area which is used to represent a text value in the parsing by template functionality.
1005
+ */
1006
+ pageTextArea: PageTextArea;
1007
+ /**
1008
+ * Gets or sets the table area. Represents a table page area which is used to represent a table in the parsing by template functionality.
1009
+ */
1010
+ pageTableArea: PageTableArea;
1011
+ constructor(init?: Partial<PageArea>);
1012
+ }
1013
+ /**
1014
+ * Represents a table page area which is used to represent a table in the parsing by template functionality.
1015
+ */
1016
+ export declare class PageTableArea {
1017
+ /**
1018
+ * Attribute type map
1019
+ */
1020
+ static attributeTypeMap: Array<{
1021
+ name: string;
1022
+ baseName: string;
1023
+ type: string;
1024
+ }>;
1025
+ /**
1026
+ * Returns attribute type map
1027
+ */
1028
+ static getAttributeTypeMap(): {
1029
+ name: string;
1030
+ baseName: string;
1031
+ type: string;
1032
+ }[];
1033
+ /**
1034
+ * Gets or sets the total number of the table rows.
1035
+ */
1036
+ rowCount: number;
1037
+ /**
1038
+ * Gets or sets the total number of the table columns.
1039
+ */
1040
+ columnCount: number;
1041
+ /**
1042
+ * Gets or sets the collection of table area cell.
1043
+ */
1044
+ pageTableAreaCells: Array<PageTableAreaCell>;
1045
+ constructor(init?: Partial<PageTableArea>);
1046
+ }
1047
+ /**
1048
+ * Represents a table cell.
1049
+ */
1050
+ export declare class PageTableAreaCell {
1051
+ /**
1052
+ * Attribute type map
1053
+ */
1054
+ static attributeTypeMap: Array<{
1055
+ name: string;
1056
+ baseName: string;
1057
+ type: string;
1058
+ }>;
1059
+ /**
1060
+ * Returns attribute type map
1061
+ */
1062
+ static getAttributeTypeMap(): {
1063
+ name: string;
1064
+ baseName: string;
1065
+ type: string;
1066
+ }[];
1067
+ /**
1068
+ * Gets or sets the index of the column.
1069
+ */
1070
+ columnIndex: number;
1071
+ /**
1072
+ * Gets or sets the total number of columns that contain the table cell.
1073
+ */
1074
+ columnSpan: number;
1075
+ /**
1076
+ * Gets or sets the table cell value.
1077
+ */
1078
+ pageArea: PageArea;
1079
+ /**
1080
+ * Gets or sets the index of the row.
1081
+ */
1082
+ rowIndex: number;
1083
+ /**
1084
+ * Gets or sets the total number of rows that contain the table cell.
1085
+ */
1086
+ rowSpan: number;
1087
+ constructor(init?: Partial<PageTableAreaCell>);
1088
+ }
1089
+ /**
1090
+ * Represents a page text area which is used to represent a text value in the parsing by template functionality.
1091
+ */
1092
+ export declare class PageTextArea {
1093
+ /**
1094
+ * Attribute type map
1095
+ */
1096
+ static attributeTypeMap: Array<{
1097
+ name: string;
1098
+ baseName: string;
1099
+ type: string;
1100
+ }>;
1101
+ /**
1102
+ * Returns attribute type map
1103
+ */
1104
+ static getAttributeTypeMap(): {
1105
+ name: string;
1106
+ baseName: string;
1107
+ type: string;
1108
+ }[];
1109
+ /**
1110
+ * Gets or sets the text.
1111
+ */
1112
+ text: string;
1113
+ /**
1114
+ * Gets or sets the base line.
1115
+ */
1116
+ baseLine: number;
1117
+ /**
1118
+ * Gets or sets the collection of child text page areas.
1119
+ */
1120
+ areas: Array<PageTextArea>;
1121
+ /**
1122
+ * Gets or sets the text style such as font size, font name an so on.
1123
+ */
1124
+ textStyle: TextStyle;
1125
+ constructor(init?: Partial<PageTextArea>);
1126
+ }
1127
+ /**
1128
+ * Parse result.
1129
+ */
1130
+ export declare class ParseResult {
1131
+ /**
1132
+ * Attribute type map
1133
+ */
1134
+ static attributeTypeMap: Array<{
1135
+ name: string;
1136
+ baseName: string;
1137
+ type: string;
1138
+ }>;
1139
+ /**
1140
+ * Returns attribute type map
1141
+ */
1142
+ static getAttributeTypeMap(): {
1143
+ name: string;
1144
+ baseName: string;
1145
+ type: string;
1146
+ }[];
1147
+ /**
1148
+ * Gets or sets the total number of the fields data.
1149
+ */
1150
+ count: number;
1151
+ /**
1152
+ * Collection of the data fields.
1153
+ */
1154
+ fieldsData: Array<FieldData>;
1155
+ constructor(init?: Partial<ParseResult>);
1156
+ }
1157
+ /**
1158
+ * Base options class.
1159
+ */
1160
+ export declare class ParserOptions {
1161
+ /**
1162
+ * Attribute type map
1163
+ */
1164
+ static attributeTypeMap: Array<{
1165
+ name: string;
1166
+ baseName: string;
1167
+ type: string;
1168
+ }>;
1169
+ /**
1170
+ * Returns attribute type map
1171
+ */
1172
+ static getAttributeTypeMap(): {
1173
+ name: string;
1174
+ baseName: string;
1175
+ type: string;
1176
+ }[];
1177
+ /**
1178
+ * Gets or sets the file information.
1179
+ */
1180
+ fileInfo: FileInfo;
1181
+ /**
1182
+ * Gets or sets the container item information.
1183
+ */
1184
+ containerItemInfo: ContainerItemInfo;
1185
+ constructor(init?: Partial<ParserOptions>);
1186
+ }
1187
+ /**
1188
+ * Class for rectangle position model.
1189
+ */
1190
+ export declare class Point {
1191
+ /**
1192
+ * Attribute type map
1193
+ */
1194
+ static attributeTypeMap: Array<{
1195
+ name: string;
1196
+ baseName: string;
1197
+ type: string;
1198
+ }>;
1199
+ /**
1200
+ * Returns attribute type map
1201
+ */
1202
+ static getAttributeTypeMap(): {
1203
+ name: string;
1204
+ baseName: string;
1205
+ type: string;
1206
+ }[];
1207
+ /**
1208
+ * Gets or sets the x-coordinate.
1209
+ */
1210
+ x: number;
1211
+ /**
1212
+ * Gets or sets the y-coordinate.
1213
+ */
1214
+ y: number;
1215
+ constructor(init?: Partial<Point>);
1216
+ }
1217
+ /**
1218
+ * Rectangular area on the page.
1219
+ */
1220
+ export declare class Rectangle {
1221
+ /**
1222
+ * Attribute type map
1223
+ */
1224
+ static attributeTypeMap: Array<{
1225
+ name: string;
1226
+ baseName: string;
1227
+ type: string;
1228
+ }>;
1229
+ /**
1230
+ * Returns attribute type map
1231
+ */
1232
+ static getAttributeTypeMap(): {
1233
+ name: string;
1234
+ baseName: string;
1235
+ type: string;
1236
+ }[];
1237
+ /**
1238
+ * Gets the coordinates of the upper-left corner of the rectangular area.
1239
+ */
1240
+ position: Point;
1241
+ /**
1242
+ * Gets or sets the size of the rectangle.
1243
+ */
1244
+ size: Size;
1245
+ /**
1246
+ * Gets or sets the coordinates.
1247
+ */
1248
+ coordinates: Coordinates;
1249
+ constructor(init?: Partial<Rectangle>);
1250
+ }
1251
+ /**
1252
+ * Represents a size of rectangular area.
1253
+ */
1254
+ export declare class Size {
1255
+ /**
1256
+ * Attribute type map
1257
+ */
1258
+ static attributeTypeMap: Array<{
1259
+ name: string;
1260
+ baseName: string;
1261
+ type: string;
1262
+ }>;
1263
+ /**
1264
+ * Returns attribute type map
1265
+ */
1266
+ static getAttributeTypeMap(): {
1267
+ name: string;
1268
+ baseName: string;
1269
+ type: string;
1270
+ }[];
1271
+ /**
1272
+ * Gets or sets the height.
1273
+ */
1274
+ height: number;
1275
+ /**
1276
+ * Gets or sets the width.
1277
+ */
1278
+ width: number;
1279
+ constructor(init?: Partial<Size>);
1280
+ }
1281
+ /**
1282
+ * Storage exists
1283
+ */
1284
+ export declare class StorageExist {
1285
+ /**
1286
+ * Attribute type map
1287
+ */
1288
+ static attributeTypeMap: Array<{
1289
+ name: string;
1290
+ baseName: string;
1291
+ type: string;
1292
+ }>;
1293
+ /**
1294
+ * Returns attribute type map
1295
+ */
1296
+ static getAttributeTypeMap(): {
1297
+ name: string;
1298
+ baseName: string;
1299
+ type: string;
1300
+ }[];
1301
+ /**
1302
+ * Shows that the storage exists.
1303
+ */
1304
+ exists: boolean;
1305
+ constructor(init?: Partial<StorageExist>);
1306
+ }
1307
+ /**
1308
+ * File or folder information
1309
+ */
1310
+ export declare class StorageFile {
1311
+ /**
1312
+ * Attribute type map
1313
+ */
1314
+ static attributeTypeMap: Array<{
1315
+ name: string;
1316
+ baseName: string;
1317
+ type: string;
1318
+ }>;
1319
+ /**
1320
+ * Returns attribute type map
1321
+ */
1322
+ static getAttributeTypeMap(): {
1323
+ name: string;
1324
+ baseName: string;
1325
+ type: string;
1326
+ }[];
1327
+ /**
1328
+ * File or folder name.
1329
+ */
1330
+ name: string;
1331
+ /**
1332
+ * True if it is a folder.
1333
+ */
1334
+ isFolder: boolean;
1335
+ /**
1336
+ * File or folder last modified DateTime.
1337
+ */
1338
+ modifiedDate: Date;
1339
+ /**
1340
+ * File or folder size.
1341
+ */
1342
+ size: number;
1343
+ /**
1344
+ * File or folder path.
1345
+ */
1346
+ path: string;
1347
+ constructor(init?: Partial<StorageFile>);
1348
+ }
1349
+ /**
1350
+ * Document template table
1351
+ */
1352
+ export declare class Table {
1353
+ /**
1354
+ * Attribute type map
1355
+ */
1356
+ static attributeTypeMap: Array<{
1357
+ name: string;
1358
+ baseName: string;
1359
+ type: string;
1360
+ }>;
1361
+ /**
1362
+ * Returns attribute type map
1363
+ */
1364
+ static getAttributeTypeMap(): {
1365
+ name: string;
1366
+ baseName: string;
1367
+ type: string;
1368
+ }[];
1369
+ /**
1370
+ * Gets or sets a unique template table name.
1371
+ */
1372
+ tableName: string;
1373
+ /**
1374
+ * The page index. An integer value that represents the index of the page where the template item is located; null if the template item is located on any page.
1375
+ */
1376
+ pageIndex: number;
1377
+ /**
1378
+ * Gets or sets the detector parameters. Provides parameters for the table detection algorithms.
1379
+ */
1380
+ detectorParameters: DetectorParameters;
1381
+ /**
1382
+ * Gets or sets the table layout. Provides the template table layout which is used by Table to define table position.
1383
+ */
1384
+ tableLayout: TableLayout;
1385
+ constructor(init?: Partial<Table>);
1386
+ }
1387
+ /**
1388
+ * Provides the template table layout which is used by Table to define table position.
1389
+ */
1390
+ export declare class TableLayout {
1391
+ /**
1392
+ * Attribute type map
1393
+ */
1394
+ static attributeTypeMap: Array<{
1395
+ name: string;
1396
+ baseName: string;
1397
+ type: string;
1398
+ }>;
1399
+ /**
1400
+ * Returns attribute type map
1401
+ */
1402
+ static getAttributeTypeMap(): {
1403
+ name: string;
1404
+ baseName: string;
1405
+ type: string;
1406
+ }[];
1407
+ /**
1408
+ * Gets or sets the table columns separators.
1409
+ */
1410
+ verticalSeparators: Array<number>;
1411
+ /**
1412
+ * Gets or sets the table rows separators.
1413
+ */
1414
+ horizontalSeparators: Array<number>;
1415
+ constructor(init?: Partial<TableLayout>);
1416
+ }
1417
+ /**
1418
+ * User-generated template to extract metadata from the document.
1419
+ */
1420
+ export declare class Template {
1421
+ /**
1422
+ * Attribute type map
1423
+ */
1424
+ static attributeTypeMap: Array<{
1425
+ name: string;
1426
+ baseName: string;
1427
+ type: string;
1428
+ }>;
1429
+ /**
1430
+ * Returns attribute type map
1431
+ */
1432
+ static getAttributeTypeMap(): {
1433
+ name: string;
1434
+ baseName: string;
1435
+ type: string;
1436
+ }[];
1437
+ /**
1438
+ * Template fields.
1439
+ */
1440
+ fields: Array<Field>;
1441
+ /**
1442
+ * Template tables.
1443
+ */
1444
+ tables: Array<Table>;
1445
+ constructor(init?: Partial<Template>);
1446
+ }
1447
+ /**
1448
+ * Template methods options.
1449
+ */
1450
+ export declare class TemplateOptions {
1451
+ /**
1452
+ * Attribute type map
1453
+ */
1454
+ static attributeTypeMap: Array<{
1455
+ name: string;
1456
+ baseName: string;
1457
+ type: string;
1458
+ }>;
1459
+ /**
1460
+ * Returns attribute type map
1461
+ */
1462
+ static getAttributeTypeMap(): {
1463
+ name: string;
1464
+ baseName: string;
1465
+ type: string;
1466
+ }[];
1467
+ /**
1468
+ * Gets or sets the template path.
1469
+ */
1470
+ templatePath: string;
1471
+ /**
1472
+ * Gets or sets the name of the storage.
1473
+ */
1474
+ storageName: string;
1475
+ constructor(init?: Partial<TemplateOptions>);
1476
+ }
1477
+ /**
1478
+ * Document template result.
1479
+ */
1480
+ export declare class TemplateResult {
1481
+ /**
1482
+ * Attribute type map
1483
+ */
1484
+ static attributeTypeMap: Array<{
1485
+ name: string;
1486
+ baseName: string;
1487
+ type: string;
1488
+ }>;
1489
+ /**
1490
+ * Returns attribute type map
1491
+ */
1492
+ static getAttributeTypeMap(): {
1493
+ name: string;
1494
+ baseName: string;
1495
+ type: string;
1496
+ }[];
1497
+ /**
1498
+ * Gets or sets the template download URL.
1499
+ */
1500
+ url: string;
1501
+ /**
1502
+ * Gets or sets the path of the template, located in the storage.
1503
+ */
1504
+ templatePath: string;
1505
+ constructor(init?: Partial<TemplateResult>);
1506
+ }
1507
+ /**
1508
+ * Extracted text page class.
1509
+ */
1510
+ export declare class TextPage {
1511
+ /**
1512
+ * Attribute type map
1513
+ */
1514
+ static attributeTypeMap: Array<{
1515
+ name: string;
1516
+ baseName: string;
1517
+ type: string;
1518
+ }>;
1519
+ /**
1520
+ * Returns attribute type map
1521
+ */
1522
+ static getAttributeTypeMap(): {
1523
+ name: string;
1524
+ baseName: string;
1525
+ type: string;
1526
+ }[];
1527
+ /**
1528
+ * Gets or sets the pageIndex.
1529
+ */
1530
+ pageIndex: number;
1531
+ /**
1532
+ * Gets or sets the text.
1533
+ */
1534
+ text: string;
1535
+ constructor(init?: Partial<TextPage>);
1536
+ }
1537
+ /**
1538
+ * The result od text extraction.
1539
+ */
1540
+ export declare class TextResult {
1541
+ /**
1542
+ * Attribute type map
1543
+ */
1544
+ static attributeTypeMap: Array<{
1545
+ name: string;
1546
+ baseName: string;
1547
+ type: string;
1548
+ }>;
1549
+ /**
1550
+ * Returns attribute type map
1551
+ */
1552
+ static getAttributeTypeMap(): {
1553
+ name: string;
1554
+ baseName: string;
1555
+ type: string;
1556
+ }[];
1557
+ /**
1558
+ * Gets or sets the pages.
1559
+ */
1560
+ pages: Array<TextPage>;
1561
+ /**
1562
+ * Gets or sets the text.
1563
+ */
1564
+ text: string;
1565
+ constructor(init?: Partial<TextResult>);
1566
+ }
1567
+ /**
1568
+ * The text style such as font size, font name an so on.
1569
+ */
1570
+ export declare class TextStyle {
1571
+ /**
1572
+ * Attribute type map
1573
+ */
1574
+ static attributeTypeMap: Array<{
1575
+ name: string;
1576
+ baseName: string;
1577
+ type: string;
1578
+ }>;
1579
+ /**
1580
+ * Returns attribute type map
1581
+ */
1582
+ static getAttributeTypeMap(): {
1583
+ name: string;
1584
+ baseName: string;
1585
+ type: string;
1586
+ }[];
1587
+ /**
1588
+ * Gets or sets the name of the font.
1589
+ */
1590
+ fontName: string;
1591
+ /**
1592
+ * Gets or sets the size of the font.
1593
+ */
1594
+ fontSize: number;
1595
+ /**
1596
+ * Gets or sets the value that indicates whether the font is bold.
1597
+ */
1598
+ isBold: boolean;
1599
+ /**
1600
+ * Gets or sets the value that indicates whether the font is italic.
1601
+ */
1602
+ isItalic: boolean;
1603
+ /**
1604
+ * Gets or sets the style name.
1605
+ */
1606
+ name: string;
1607
+ constructor(init?: Partial<TextStyle>);
1608
+ }
1609
+ /**
1610
+ * Barcode options.
1611
+ */
1612
+ export declare class BarcodesOptions extends ParserOptions {
1613
+ /**
1614
+ * Attribute type map
1615
+ */
1616
+ static attributeTypeMap: Array<{
1617
+ name: string;
1618
+ baseName: string;
1619
+ type: string;
1620
+ }>;
1621
+ /**
1622
+ * Returns attribute type map
1623
+ */
1624
+ static getAttributeTypeMap(): {
1625
+ name: string;
1626
+ baseName: string;
1627
+ type: string;
1628
+ }[];
1629
+ /**
1630
+ * Gets or sets the output path for extracted barcodes.
1631
+ */
1632
+ outputPath: string;
1633
+ /**
1634
+ * Gets or sets the zero-based start page index.
1635
+ */
1636
+ startPageNumber: number;
1637
+ /**
1638
+ * Gets or sets the number of pages to extract.
1639
+ */
1640
+ countPagesToExtract: number;
1641
+ constructor(init?: Partial<BarcodesOptions>);
1642
+ }
1643
+ /**
1644
+ * Container options.
1645
+ */
1646
+ export declare class ContainerOptions extends ParserOptions {
1647
+ /**
1648
+ * Attribute type map
1649
+ */
1650
+ static attributeTypeMap: Array<{
1651
+ name: string;
1652
+ baseName: string;
1653
+ type: string;
1654
+ }>;
1655
+ /**
1656
+ * Returns attribute type map
1657
+ */
1658
+ static getAttributeTypeMap(): {
1659
+ name: string;
1660
+ baseName: string;
1661
+ type: string;
1662
+ }[];
1663
+ constructor(init?: Partial<ContainerOptions>);
1664
+ }
1665
+ /**
1666
+ * File Version
1667
+ */
1668
+ export declare class FileVersion extends StorageFile {
1669
+ /**
1670
+ * Attribute type map
1671
+ */
1672
+ static attributeTypeMap: Array<{
1673
+ name: string;
1674
+ baseName: string;
1675
+ type: string;
1676
+ }>;
1677
+ /**
1678
+ * Returns attribute type map
1679
+ */
1680
+ static getAttributeTypeMap(): {
1681
+ name: string;
1682
+ baseName: string;
1683
+ type: string;
1684
+ }[];
1685
+ /**
1686
+ * File Version ID.
1687
+ */
1688
+ versionId: string;
1689
+ /**
1690
+ * Specifies whether the file is (true) or is not (false) the latest version of an file.
1691
+ */
1692
+ isLatest: boolean;
1693
+ constructor(init?: Partial<FileVersion>);
1694
+ }
1695
+ /**
1696
+ * Image options.
1697
+ */
1698
+ export declare class ImagesOptions extends ParserOptions {
1699
+ /**
1700
+ * Attribute type map
1701
+ */
1702
+ static attributeTypeMap: Array<{
1703
+ name: string;
1704
+ baseName: string;
1705
+ type: string;
1706
+ }>;
1707
+ /**
1708
+ * Returns attribute type map
1709
+ */
1710
+ static getAttributeTypeMap(): {
1711
+ name: string;
1712
+ baseName: string;
1713
+ type: string;
1714
+ }[];
1715
+ /**
1716
+ * Gets or sets the output path for extracted images.
1717
+ */
1718
+ outputPath: string;
1719
+ /**
1720
+ * Gets or sets the zero-based start page index.
1721
+ */
1722
+ startPageNumber: number;
1723
+ /**
1724
+ * Gets or sets the number of pages to extract.
1725
+ */
1726
+ countPagesToExtract: number;
1727
+ constructor(init?: Partial<ImagesOptions>);
1728
+ }
1729
+ /**
1730
+ * Info options
1731
+ */
1732
+ export declare class InfoOptions extends ParserOptions {
1733
+ /**
1734
+ * Attribute type map
1735
+ */
1736
+ static attributeTypeMap: Array<{
1737
+ name: string;
1738
+ baseName: string;
1739
+ type: string;
1740
+ }>;
1741
+ /**
1742
+ * Returns attribute type map
1743
+ */
1744
+ static getAttributeTypeMap(): {
1745
+ name: string;
1746
+ baseName: string;
1747
+ type: string;
1748
+ }[];
1749
+ constructor(init?: Partial<InfoOptions>);
1750
+ }
1751
+ /**
1752
+ * Parse options.
1753
+ */
1754
+ export declare class ParseOptions extends ParserOptions {
1755
+ /**
1756
+ * Attribute type map
1757
+ */
1758
+ static attributeTypeMap: Array<{
1759
+ name: string;
1760
+ baseName: string;
1761
+ type: string;
1762
+ }>;
1763
+ /**
1764
+ * Returns attribute type map
1765
+ */
1766
+ static getAttributeTypeMap(): {
1767
+ name: string;
1768
+ baseName: string;
1769
+ type: string;
1770
+ }[];
1771
+ /**
1772
+ * User-generated template to extract metadata from the document.
1773
+ */
1774
+ template: Template;
1775
+ /**
1776
+ * The path of the file, located in the storage, which contains a user-generated template to parse data. Is used when the Template parameter is not provided.
1777
+ */
1778
+ templatePath: string;
1779
+ constructor(init?: Partial<ParseOptions>);
1780
+ }
1781
+ /**
1782
+ * Extract options.
1783
+ */
1784
+ export declare class TextOptions extends ParserOptions {
1785
+ /**
1786
+ * Attribute type map
1787
+ */
1788
+ static attributeTypeMap: Array<{
1789
+ name: string;
1790
+ baseName: string;
1791
+ type: string;
1792
+ }>;
1793
+ /**
1794
+ * Returns attribute type map
1795
+ */
1796
+ static getAttributeTypeMap(): {
1797
+ name: string;
1798
+ baseName: string;
1799
+ type: string;
1800
+ }[];
1801
+ /**
1802
+ * Gets or sets the options which are used for formatted text extraction.
1803
+ */
1804
+ formattedTextOptions: FormattedTextOptions;
1805
+ /**
1806
+ * Gets or sets the zero-based start page index.
1807
+ */
1808
+ startPageNumber: number;
1809
+ /**
1810
+ * Gets or sets the number of pages to extract.
1811
+ */
1812
+ countPagesToExtract: number;
1813
+ constructor(init?: Partial<TextOptions>);
1814
+ }
1815
+ declare const enumsMap: {};
1816
+ declare const typeMap: {
1817
+ Barcode: typeof Barcode;
1818
+ BarcodePage: typeof BarcodePage;
1819
+ BarcodesResult: typeof BarcodesResult;
1820
+ ContainerItem: typeof ContainerItem;
1821
+ ContainerItemInfo: typeof ContainerItemInfo;
1822
+ ContainerResult: typeof ContainerResult;
1823
+ Coordinates: typeof Coordinates;
1824
+ CreateTemplateOptions: typeof CreateTemplateOptions;
1825
+ DetectorParameters: typeof DetectorParameters;
1826
+ DiscUsage: typeof DiscUsage;
1827
+ ErrorDetails: typeof ErrorDetails;
1828
+ Field: typeof Field;
1829
+ FieldData: typeof FieldData;
1830
+ FieldPosition: typeof FieldPosition;
1831
+ FileInfo: typeof FileInfo;
1832
+ FileType: typeof FileType;
1833
+ FileVersions: typeof FileVersions;
1834
+ FilesList: typeof FilesList;
1835
+ FilesUploadResult: typeof FilesUploadResult;
1836
+ Format: typeof Format;
1837
+ FormatsResult: typeof FormatsResult;
1838
+ FormattedTextOptions: typeof FormattedTextOptions;
1839
+ Image: typeof Image;
1840
+ ImagePage: typeof ImagePage;
1841
+ ImagesResult: typeof ImagesResult;
1842
+ InfoResult: typeof InfoResult;
1843
+ ModelError: typeof ModelError;
1844
+ ObjectExist: typeof ObjectExist;
1845
+ Page: typeof Page;
1846
+ PageArea: typeof PageArea;
1847
+ PageTableArea: typeof PageTableArea;
1848
+ PageTableAreaCell: typeof PageTableAreaCell;
1849
+ PageTextArea: typeof PageTextArea;
1850
+ ParseResult: typeof ParseResult;
1851
+ ParserOptions: typeof ParserOptions;
1852
+ Point: typeof Point;
1853
+ Rectangle: typeof Rectangle;
1854
+ Size: typeof Size;
1855
+ StorageExist: typeof StorageExist;
1856
+ StorageFile: typeof StorageFile;
1857
+ Table: typeof Table;
1858
+ TableLayout: typeof TableLayout;
1859
+ Template: typeof Template;
1860
+ TemplateOptions: typeof TemplateOptions;
1861
+ TemplateResult: typeof TemplateResult;
1862
+ TextPage: typeof TextPage;
1863
+ TextResult: typeof TextResult;
1864
+ TextStyle: typeof TextStyle;
1865
+ BarcodesOptions: typeof BarcodesOptions;
1866
+ ContainerOptions: typeof ContainerOptions;
1867
+ FileVersion: typeof FileVersion;
1868
+ ImagesOptions: typeof ImagesOptions;
1869
+ InfoOptions: typeof InfoOptions;
1870
+ ParseOptions: typeof ParseOptions;
1871
+ TextOptions: typeof TextOptions;
1872
+ };
1873
+ export { enumsMap, typeMap };
1874
+ /**
1875
+ * Request model for CopyFile operation.
1876
+ */
1877
+ export declare class CopyFileRequest {
1878
+ /**
1879
+ * Source file path e.g. '/folder/file.ext'
1880
+ */
1881
+ srcPath: string;
1882
+ /**
1883
+ * Destination file path
1884
+ */
1885
+ destPath: string;
1886
+ /**
1887
+ * Source storage name
1888
+ */
1889
+ srcStorageName: string;
1890
+ /**
1891
+ * Destination storage name
1892
+ */
1893
+ destStorageName: string;
1894
+ /**
1895
+ * File version ID to copy
1896
+ */
1897
+ versionId: string;
1898
+ constructor(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string, versionId?: string);
1899
+ }
1900
+ /**
1901
+ * Request model for DeleteFile operation.
1902
+ */
1903
+ export declare class DeleteFileRequest {
1904
+ /**
1905
+ * File path e.g. '/folder/file.ext'
1906
+ */
1907
+ path: string;
1908
+ /**
1909
+ * Storage name
1910
+ */
1911
+ storageName: string;
1912
+ /**
1913
+ * File version ID to delete
1914
+ */
1915
+ versionId: string;
1916
+ constructor(path: string, storageName?: string, versionId?: string);
1917
+ }
1918
+ /**
1919
+ * Request model for DownloadFile operation.
1920
+ */
1921
+ export declare class DownloadFileRequest {
1922
+ /**
1923
+ * File path e.g. '/folder/file.ext'
1924
+ */
1925
+ path: string;
1926
+ /**
1927
+ * Storage name
1928
+ */
1929
+ storageName: string;
1930
+ /**
1931
+ * File version ID to download
1932
+ */
1933
+ versionId: string;
1934
+ constructor(path: string, storageName?: string, versionId?: string);
1935
+ }
1936
+ /**
1937
+ * Request model for MoveFile operation.
1938
+ */
1939
+ export declare class MoveFileRequest {
1940
+ /**
1941
+ * Source file path e.g. '/src.ext'
1942
+ */
1943
+ srcPath: string;
1944
+ /**
1945
+ * Destination file path e.g. '/dest.ext'
1946
+ */
1947
+ destPath: string;
1948
+ /**
1949
+ * Source storage name
1950
+ */
1951
+ srcStorageName: string;
1952
+ /**
1953
+ * Destination storage name
1954
+ */
1955
+ destStorageName: string;
1956
+ /**
1957
+ * File version ID to move
1958
+ */
1959
+ versionId: string;
1960
+ constructor(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string, versionId?: string);
1961
+ }
1962
+ /**
1963
+ * Request model for UploadFile operation.
1964
+ */
1965
+ export declare class UploadFileRequest {
1966
+ /**
1967
+ * Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header.
1968
+ */
1969
+ path: string;
1970
+ /**
1971
+ * File to upload
1972
+ */
1973
+ file: Buffer;
1974
+ /**
1975
+ * Storage name
1976
+ */
1977
+ storageName: string;
1978
+ constructor(path: string, file: Buffer, storageName?: string);
1979
+ }
1980
+ /**
1981
+ * Request model for CopyFolder operation.
1982
+ */
1983
+ export declare class CopyFolderRequest {
1984
+ /**
1985
+ * Source folder path e.g. '/src'
1986
+ */
1987
+ srcPath: string;
1988
+ /**
1989
+ * Destination folder path e.g. '/dst'
1990
+ */
1991
+ destPath: string;
1992
+ /**
1993
+ * Source storage name
1994
+ */
1995
+ srcStorageName: string;
1996
+ /**
1997
+ * Destination storage name
1998
+ */
1999
+ destStorageName: string;
2000
+ constructor(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string);
2001
+ }
2002
+ /**
2003
+ * Request model for CreateFolder operation.
2004
+ */
2005
+ export declare class CreateFolderRequest {
2006
+ /**
2007
+ * Folder path to create e.g. 'folder_1/folder_2/'
2008
+ */
2009
+ path: string;
2010
+ /**
2011
+ * Storage name
2012
+ */
2013
+ storageName: string;
2014
+ constructor(path: string, storageName?: string);
2015
+ }
2016
+ /**
2017
+ * Request model for DeleteFolder operation.
2018
+ */
2019
+ export declare class DeleteFolderRequest {
2020
+ /**
2021
+ * Folder path e.g. '/folder'
2022
+ */
2023
+ path: string;
2024
+ /**
2025
+ * Storage name
2026
+ */
2027
+ storageName: string;
2028
+ /**
2029
+ * Enable to delete folders, subfolders and files
2030
+ */
2031
+ recursive: boolean;
2032
+ constructor(path: string, storageName?: string, recursive?: boolean);
2033
+ }
2034
+ /**
2035
+ * Request model for GetFilesList operation.
2036
+ */
2037
+ export declare class GetFilesListRequest {
2038
+ /**
2039
+ * Folder path e.g. '/folder'
2040
+ */
2041
+ path: string;
2042
+ /**
2043
+ * Storage name
2044
+ */
2045
+ storageName: string;
2046
+ constructor(path: string, storageName?: string);
2047
+ }
2048
+ /**
2049
+ * Request model for MoveFolder operation.
2050
+ */
2051
+ export declare class MoveFolderRequest {
2052
+ /**
2053
+ * Folder path to move e.g. '/folder'
2054
+ */
2055
+ srcPath: string;
2056
+ /**
2057
+ * Destination folder path to move to e.g '/dst'
2058
+ */
2059
+ destPath: string;
2060
+ /**
2061
+ * Source storage name
2062
+ */
2063
+ srcStorageName: string;
2064
+ /**
2065
+ * Destination storage name
2066
+ */
2067
+ destStorageName: string;
2068
+ constructor(srcPath: string, destPath: string, srcStorageName?: string, destStorageName?: string);
2069
+ }
2070
+ /**
2071
+ * Request model for Container operation.
2072
+ */
2073
+ export declare class ContainerRequest {
2074
+ /**
2075
+ * Container options.
2076
+ */
2077
+ options: ContainerOptions;
2078
+ constructor(options: ContainerOptions);
2079
+ }
2080
+ /**
2081
+ * Request model for GetInfo operation.
2082
+ */
2083
+ export declare class GetInfoRequest {
2084
+ /**
2085
+ * Info options.
2086
+ */
2087
+ options: InfoOptions;
2088
+ constructor(options: InfoOptions);
2089
+ }
2090
+ /**
2091
+ * Request model for Barcodes operation.
2092
+ */
2093
+ export declare class BarcodesRequest {
2094
+ /**
2095
+ * Extract barcode options.
2096
+ */
2097
+ options: BarcodesOptions;
2098
+ constructor(options: BarcodesOptions);
2099
+ }
2100
+ /**
2101
+ * Request model for Images operation.
2102
+ */
2103
+ export declare class ImagesRequest {
2104
+ /**
2105
+ * Extract image options.
2106
+ */
2107
+ options: ImagesOptions;
2108
+ constructor(options: ImagesOptions);
2109
+ }
2110
+ /**
2111
+ * Request model for Parse operation.
2112
+ */
2113
+ export declare class ParseRequest {
2114
+ /**
2115
+ * Parse options.
2116
+ */
2117
+ options: ParseOptions;
2118
+ constructor(options: ParseOptions);
2119
+ }
2120
+ /**
2121
+ * Request model for Text operation.
2122
+ */
2123
+ export declare class TextRequest {
2124
+ /**
2125
+ * Extract text options.
2126
+ */
2127
+ options: TextOptions;
2128
+ constructor(options: TextOptions);
2129
+ }
2130
+ /**
2131
+ * Request model for GetDiscUsage operation.
2132
+ */
2133
+ export declare class GetDiscUsageRequest {
2134
+ /**
2135
+ * Storage name
2136
+ */
2137
+ storageName: string;
2138
+ constructor(storageName?: string);
2139
+ }
2140
+ /**
2141
+ * Request model for GetFileVersions operation.
2142
+ */
2143
+ export declare class GetFileVersionsRequest {
2144
+ /**
2145
+ * File path e.g. '/file.ext'
2146
+ */
2147
+ path: string;
2148
+ /**
2149
+ * Storage name
2150
+ */
2151
+ storageName: string;
2152
+ constructor(path: string, storageName?: string);
2153
+ }
2154
+ /**
2155
+ * Request model for ObjectExists operation.
2156
+ */
2157
+ export declare class ObjectExistsRequest {
2158
+ /**
2159
+ * File or folder path e.g. '/file.ext' or '/folder'
2160
+ */
2161
+ path: string;
2162
+ /**
2163
+ * Storage name
2164
+ */
2165
+ storageName: string;
2166
+ /**
2167
+ * File version ID
2168
+ */
2169
+ versionId: string;
2170
+ constructor(path: string, storageName?: string, versionId?: string);
2171
+ }
2172
+ /**
2173
+ * Request model for StorageExists operation.
2174
+ */
2175
+ export declare class StorageExistsRequest {
2176
+ /**
2177
+ * Storage name
2178
+ */
2179
+ storageName: string;
2180
+ constructor(storageName: string);
2181
+ }
2182
+ /**
2183
+ * Request model for CreateTemplate operation.
2184
+ */
2185
+ export declare class CreateTemplateRequest {
2186
+ /**
2187
+ * Create template options.
2188
+ */
2189
+ options: CreateTemplateOptions;
2190
+ constructor(options: CreateTemplateOptions);
2191
+ }
2192
+ /**
2193
+ * Request model for DeleteTemplate operation.
2194
+ */
2195
+ export declare class DeleteTemplateRequest {
2196
+ /**
2197
+ * Delete template options.
2198
+ */
2199
+ options: TemplateOptions;
2200
+ constructor(options: TemplateOptions);
2201
+ }
2202
+ /**
2203
+ * Request model for GetTemplate operation.
2204
+ */
2205
+ export declare class GetTemplateRequest {
2206
+ /**
2207
+ * Retrieve template options.
2208
+ */
2209
+ options: TemplateOptions;
2210
+ constructor(options: TemplateOptions);
2211
+ }