@laserfiche/lf-repository-api-client-v2 1.0.9 → 1.1.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/dist/index.d.ts +1355 -374
- package/dist/index.js +5048 -2847
- package/package.json +9 -16
package/dist/index.d.ts
CHANGED
|
@@ -11,10 +11,10 @@ export interface IAttributesClient {
|
|
|
11
11
|
* @param args.prefer (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
12
12
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
13
13
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
14
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
14
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
15
15
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
16
16
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
17
|
-
* @returns
|
|
17
|
+
* @returns Successfully returned the list of trustee attribute key value pairs for the authenticated user.
|
|
18
18
|
*/
|
|
19
19
|
listAttributes(args: {
|
|
20
20
|
repositoryId: string;
|
|
@@ -33,7 +33,7 @@ export interface IAttributesClient {
|
|
|
33
33
|
* @param args.repositoryId The requested repository ID.
|
|
34
34
|
* @param args.attributeKey The requested attribute key.
|
|
35
35
|
* @param args.everyone (optional) Indicates if attributes associated with the "Everyone" group or the currently authenticated user is returned. The default value is false.
|
|
36
|
-
* @returns
|
|
36
|
+
* @returns Successfully returned the specified attribute for the authenticated user.
|
|
37
37
|
*/
|
|
38
38
|
getAttribute(args: {
|
|
39
39
|
repositoryId: string;
|
|
@@ -94,10 +94,10 @@ export declare class AttributesClient implements IAttributesClient {
|
|
|
94
94
|
* @param args.prefer (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
95
95
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
96
96
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
97
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
97
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
98
98
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
99
99
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
100
|
-
* @returns
|
|
100
|
+
* @returns Successfully returned the list of trustee attribute key value pairs for the authenticated user.
|
|
101
101
|
*/
|
|
102
102
|
listAttributes(args: {
|
|
103
103
|
repositoryId: string;
|
|
@@ -117,7 +117,7 @@ export declare class AttributesClient implements IAttributesClient {
|
|
|
117
117
|
* @param args.repositoryId The requested repository ID.
|
|
118
118
|
* @param args.attributeKey The requested attribute key.
|
|
119
119
|
* @param args.everyone (optional) Indicates if attributes associated with the "Everyone" group or the currently authenticated user is returned. The default value is false.
|
|
120
|
-
* @returns
|
|
120
|
+
* @returns Successfully returned the specified attribute for the authenticated user.
|
|
121
121
|
*/
|
|
122
122
|
getAttribute(args: {
|
|
123
123
|
repositoryId: string;
|
|
@@ -136,10 +136,10 @@ export interface IAuditReasonsClient {
|
|
|
136
136
|
* @param args.prefer (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
137
137
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
138
138
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
139
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
139
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
140
140
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
141
141
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
142
|
-
* @returns
|
|
142
|
+
* @returns Successfully returned list of audit reasons.
|
|
143
143
|
*/
|
|
144
144
|
listAuditReasons(args: {
|
|
145
145
|
repositoryId: string;
|
|
@@ -167,10 +167,10 @@ export declare class AuditReasonsClient implements IAuditReasonsClient {
|
|
|
167
167
|
* @param args.prefer (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
168
168
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
169
169
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
170
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
170
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
171
171
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
172
172
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
173
|
-
* @returns
|
|
173
|
+
* @returns Successfully returned list of audit reasons.
|
|
174
174
|
*/
|
|
175
175
|
listAuditReasons(args: {
|
|
176
176
|
repositoryId: string;
|
|
@@ -193,7 +193,7 @@ export interface IFieldDefinitionsClient {
|
|
|
193
193
|
* @param args.fieldId The requested field definition ID.
|
|
194
194
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
195
195
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
196
|
-
* @returns
|
|
196
|
+
* @returns Successfully returned requested field definition.
|
|
197
197
|
*/
|
|
198
198
|
getFieldDefinition(args: {
|
|
199
199
|
repositoryId: string;
|
|
@@ -211,10 +211,10 @@ export interface IFieldDefinitionsClient {
|
|
|
211
211
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
212
212
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
213
213
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
214
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
214
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
215
215
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
216
216
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
217
|
-
* @returns
|
|
217
|
+
* @returns Successfully returned field definitions.
|
|
218
218
|
*/
|
|
219
219
|
listFieldDefinitions(args: {
|
|
220
220
|
repositoryId: string;
|
|
@@ -282,7 +282,7 @@ export declare class FieldDefinitionsClient implements IFieldDefinitionsClient {
|
|
|
282
282
|
* @param args.fieldId The requested field definition ID.
|
|
283
283
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
284
284
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
285
|
-
* @returns
|
|
285
|
+
* @returns Successfully returned requested field definition.
|
|
286
286
|
*/
|
|
287
287
|
getFieldDefinition(args: {
|
|
288
288
|
repositoryId: string;
|
|
@@ -301,10 +301,10 @@ export declare class FieldDefinitionsClient implements IFieldDefinitionsClient {
|
|
|
301
301
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
302
302
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
303
303
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
304
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
304
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
305
305
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
306
306
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
307
|
-
* @returns
|
|
307
|
+
* @returns Successfully returned field definitions.
|
|
308
308
|
*/
|
|
309
309
|
listFieldDefinitions(args: {
|
|
310
310
|
repositoryId: string;
|
|
@@ -328,10 +328,10 @@ export interface ILinkDefinitionsClient {
|
|
|
328
328
|
* @param args.prefer (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
329
329
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
330
330
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
331
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
331
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
332
332
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
333
333
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
334
|
-
* @returns
|
|
334
|
+
* @returns Successfully returned link definitions.
|
|
335
335
|
*/
|
|
336
336
|
listLinkDefinitions(args: {
|
|
337
337
|
repositoryId: string;
|
|
@@ -350,7 +350,7 @@ export interface ILinkDefinitionsClient {
|
|
|
350
350
|
* @param args.repositoryId The requested repository ID.
|
|
351
351
|
* @param args.linkDefinitionId The requested link definition ID.
|
|
352
352
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
353
|
-
* @returns
|
|
353
|
+
* @returns Successfully returned specified link definition.
|
|
354
354
|
*/
|
|
355
355
|
getLinkDefinition(args: {
|
|
356
356
|
repositoryId: string;
|
|
@@ -409,10 +409,10 @@ export declare class LinkDefinitionsClient implements ILinkDefinitionsClient {
|
|
|
409
409
|
* @param args.prefer (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
410
410
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
411
411
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
412
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
412
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
413
413
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
414
414
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
415
|
-
* @returns
|
|
415
|
+
* @returns Successfully returned link definitions.
|
|
416
416
|
*/
|
|
417
417
|
listLinkDefinitions(args: {
|
|
418
418
|
repositoryId: string;
|
|
@@ -432,7 +432,7 @@ export declare class LinkDefinitionsClient implements ILinkDefinitionsClient {
|
|
|
432
432
|
* @param args.repositoryId The requested repository ID.
|
|
433
433
|
* @param args.linkDefinitionId The requested link definition ID.
|
|
434
434
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
435
|
-
* @returns
|
|
435
|
+
* @returns Successfully returned specified link definition.
|
|
436
436
|
*/
|
|
437
437
|
getLinkDefinition(args: {
|
|
438
438
|
repositoryId: string;
|
|
@@ -454,21 +454,28 @@ export interface IEntriesClient {
|
|
|
454
454
|
- Required OAuth scope: repository.Write
|
|
455
455
|
* @param args.repositoryId The requested repository ID.
|
|
456
456
|
* @param args.request The request body.
|
|
457
|
-
* @returns
|
|
457
|
+
* @returns Returned response containing an upload ID and an array of upload URLs.
|
|
458
458
|
*/
|
|
459
459
|
createMultipartUploadUrls(args: {
|
|
460
460
|
repositoryId: string;
|
|
461
461
|
request: CreateMultipartUploadUrlsRequest;
|
|
462
462
|
}): Promise<CreateMultipartUploadUrlsResponse>;
|
|
463
463
|
/**
|
|
464
|
-
* - Imports a new
|
|
465
|
-
-
|
|
464
|
+
* - Imports a new document from previously uploaded parts into the specified folder. The parts are assembled server-side into a single file that is then processed like a direct import.
|
|
465
|
+
- The uploadId is obtained from the CreateMultipartUploadUrls response. The partETags are the ETag values returned by S3 when uploading each file chunk to the pre-signed upload URLs, and should be provided in the order of their associated upload URLs.
|
|
466
|
+
- The assembled file is imported as either the electronic document or image pages, following the same rules as the synchronous POST /Folder/Import:
|
|
467
|
+
- If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if `importAsElectronicDocument=true`, the file is stored as the electronic document. For supported edoc formats, `pdfOptions.generatePages` additionally produces server-rendered image pages, and `pdfOptions.generateText` triggers text extraction from the document (or OCR when the source is image-based).
|
|
468
|
+
- Otherwise (image extension with `importAsElectronicDocument=false`), the file is imported as image pages. `pdfOptions.generateText` triggers OCR for the resulting pages.
|
|
469
|
+
- Metadata in the body is assigned to the newly created entry.
|
|
470
|
+
- Supports assembled files up to 64 GB — use this endpoint when the file exceeds the size or time limits of the synchronous POST /Folder/Import.
|
|
471
|
+
- Returns 202 Accepted with a task ID. Poll the task endpoint for progress and completion. This route does not support partial success.
|
|
472
|
+
- `imageFiles` and `generateImagePagesText` are not supported on this endpoint; use the synchronous POST /Folder/Import to attach image pages alongside the imported file.
|
|
466
473
|
- Required OAuth scope: repository.Write
|
|
467
474
|
* @param args.repositoryId The requested repository ID.
|
|
468
475
|
* @param args.entryId The entry ID of the folder that the document will be created in.
|
|
469
476
|
* @param args.request (optional) The request body.
|
|
470
477
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
|
|
471
|
-
* @returns
|
|
478
|
+
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
472
479
|
*/
|
|
473
480
|
startImportUploadedParts(args: {
|
|
474
481
|
repositoryId: string;
|
|
@@ -484,7 +491,7 @@ export interface IEntriesClient {
|
|
|
484
491
|
* @param args.entryId The ID of entry to export.
|
|
485
492
|
* @param args.request The request body.
|
|
486
493
|
* @param args.pageRange (optional) A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when part=Edoc.
|
|
487
|
-
* @returns
|
|
494
|
+
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
488
495
|
*/
|
|
489
496
|
startExportEntry(args: {
|
|
490
497
|
repositoryId: string;
|
|
@@ -502,7 +509,7 @@ export interface IEntriesClient {
|
|
|
502
509
|
* @param args.entryId The folder ID that the entry will be created in.
|
|
503
510
|
* @param args.request The request body.
|
|
504
511
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.
|
|
505
|
-
* @returns
|
|
512
|
+
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
506
513
|
*/
|
|
507
514
|
startCopyEntry(args: {
|
|
508
515
|
repositoryId: string;
|
|
@@ -518,7 +525,7 @@ export interface IEntriesClient {
|
|
|
518
525
|
* @param args.repositoryId The requested repository ID.
|
|
519
526
|
* @param args.entryId The requested entry ID.
|
|
520
527
|
* @param args.request (optional) The submitted audit reason.
|
|
521
|
-
* @returns
|
|
528
|
+
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
522
529
|
*/
|
|
523
530
|
startDeleteEntry(args: {
|
|
524
531
|
repositoryId: string;
|
|
@@ -528,13 +535,14 @@ export interface IEntriesClient {
|
|
|
528
535
|
/**
|
|
529
536
|
* - Returns a single entry object.
|
|
530
537
|
- Provide an entry ID, and get the entry associated with that ID. Useful when detailed information about the entry is required, such as metadata, path information, etc.
|
|
531
|
-
- If the entry is a subtype (Folder, Document, or Shortcut), the
|
|
538
|
+
- If the entry is a subtype (Folder, Document, or Shortcut), the response will automatically include properties specific to that entry type. For example, Document entries include page-related properties such as the number of image pages and whether an electronic document is attached. Entries with an electronic document component include the electronic document size (in bytes). Folder entries include whether the folder is a record series. Shortcut entries include the target entry ID.
|
|
532
539
|
- Allowed OData query options: Select.
|
|
540
|
+
- When OData Select query option is used, 'entryType' is always included in the result.
|
|
533
541
|
- Required OAuth scope: repository.Read
|
|
534
542
|
* @param args.repositoryId The requested repository ID.
|
|
535
543
|
* @param args.entryId The requested entry ID.
|
|
536
544
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
537
|
-
* @returns
|
|
545
|
+
* @returns Successfully retrieved requested entry.
|
|
538
546
|
*/
|
|
539
547
|
getEntry(args: {
|
|
540
548
|
repositoryId: string;
|
|
@@ -550,7 +558,7 @@ export interface IEntriesClient {
|
|
|
550
558
|
* @param args.entryId The requested entry ID.
|
|
551
559
|
* @param args.request The request containing the folder ID that the entry will be moved to and the new name the entry will be renamed to.
|
|
552
560
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.
|
|
553
|
-
* @returns
|
|
561
|
+
* @returns Succesfully moved and/or renamed the entry. Returned updated entry.
|
|
554
562
|
*/
|
|
555
563
|
updateEntry(args: {
|
|
556
564
|
repositoryId: string;
|
|
@@ -559,15 +567,23 @@ export interface IEntriesClient {
|
|
|
559
567
|
culture?: string | null | undefined;
|
|
560
568
|
}): Promise<Entry>;
|
|
561
569
|
/**
|
|
562
|
-
* -
|
|
563
|
-
- The
|
|
570
|
+
* - Imports a new document into the specified folder, optionally with electronic document content, image pages, and metadata.
|
|
571
|
+
- The `file` form field is optional. When provided, it becomes either the electronic document or image pages of the new document:
|
|
572
|
+
- If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if `importAsElectronicDocument=true`, the file is stored as the electronic document. For supported edoc formats, `pdfOptions.generatePages` additionally produces server-rendered image pages, and `pdfOptions.generateText` triggers text extraction from the document (or OCR when the source is image-based).
|
|
573
|
+
- Otherwise (image extension with `importAsElectronicDocument=false`), the file is imported as image pages. A multi-page TIFF produces multiple pages. `pdfOptions.generateText` triggers OCR for the resulting pages.
|
|
574
|
+
- A zero-byte file creates an empty document with no electronic document and no pages.
|
|
575
|
+
- The optional `imageFiles` form field accepts up to 10 image files (100 MB aggregate) that are appended as image pages. Set `generateImagePagesText=false` in the body to skip OCR for the pages added via `imageFiles` (default: true).
|
|
576
|
+
- `file` and `imageFiles` can be combined whenever the file is imported as the electronic document — i.e. non-image file types, or image file types with `importAsElectronicDocument=true`. The request returns 400 only when both are provided and the file would itself become image pages (image file type with `importAsElectronicDocument=false`).
|
|
577
|
+
- Metadata in the body is assigned to the newly created entry.
|
|
578
|
+
- Size and time limits: file must be ≤ 100 MB and the request must complete within 60 seconds. These limits may change. Use the asynchronous long-operation import endpoint for larger files or slower imports.
|
|
564
579
|
- Required OAuth scope: repository.Write
|
|
565
580
|
* @param args.repositoryId The requested repository ID.
|
|
566
581
|
* @param args.entryId The entry ID of the folder that the document will be created in.
|
|
567
582
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
|
|
568
|
-
* @param args.file (optional)
|
|
583
|
+
* @param args.file (optional) Optional. The file to import. If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, it is stored as the electronic document. Otherwise (image extension with importAsElectronicDocument=false), it is imported as image pages. A zero-byte file creates an empty document with no electronic document and no pages.
|
|
569
584
|
* @param args.request (optional)
|
|
570
|
-
* @
|
|
585
|
+
* @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. On UpdateDocument, existing pages are preserved by default and deleted first when overwriteContent=true. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
|
|
586
|
+
* @returns Document was created successfully. Returns created entry.
|
|
571
587
|
*/
|
|
572
588
|
importEntry(args: {
|
|
573
589
|
repositoryId: string;
|
|
@@ -575,6 +591,7 @@ export interface IEntriesClient {
|
|
|
575
591
|
culture?: string | null | undefined;
|
|
576
592
|
file?: FileParameter | undefined;
|
|
577
593
|
request?: ImportEntryRequest | undefined;
|
|
594
|
+
imageFiles?: FileParameter[] | undefined;
|
|
578
595
|
}): Promise<Entry>;
|
|
579
596
|
/**
|
|
580
597
|
* - Export an entry.
|
|
@@ -584,7 +601,7 @@ export interface IEntriesClient {
|
|
|
584
601
|
* @param args.entryId The ID of entry to export.
|
|
585
602
|
* @param args.request The request body.
|
|
586
603
|
* @param args.pageRange (optional) A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc.
|
|
587
|
-
* @returns
|
|
604
|
+
* @returns Export was successful. Returned a link to download the exported entry.
|
|
588
605
|
*/
|
|
589
606
|
exportEntry(args: {
|
|
590
607
|
repositoryId: string;
|
|
@@ -599,7 +616,7 @@ export interface IEntriesClient {
|
|
|
599
616
|
* @param args.repositoryId The requested repository ID.
|
|
600
617
|
* @param args.fullPath The requested entry path.
|
|
601
618
|
* @param args.fallbackToClosestAncestor (optional) An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false.
|
|
602
|
-
* @returns
|
|
619
|
+
* @returns Successfully retrieved requested entry or ancestor entry.
|
|
603
620
|
*/
|
|
604
621
|
getEntryByPath(args: {
|
|
605
622
|
repositoryId: string;
|
|
@@ -623,10 +640,10 @@ export interface IEntriesClient {
|
|
|
623
640
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.
|
|
624
641
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
625
642
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
626
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
643
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
627
644
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
628
645
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
629
|
-
* @returns
|
|
646
|
+
* @returns Successfully returned list of children entries in requested folder.
|
|
630
647
|
*/
|
|
631
648
|
listEntries(args: {
|
|
632
649
|
repositoryId: string;
|
|
@@ -650,7 +667,7 @@ export interface IEntriesClient {
|
|
|
650
667
|
* @param args.entryId The folder ID that the entry will be created in.
|
|
651
668
|
* @param args.request The request body.
|
|
652
669
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.
|
|
653
|
-
* @returns
|
|
670
|
+
* @returns Document was created successfully. Returns created entry.
|
|
654
671
|
*/
|
|
655
672
|
createEntry(args: {
|
|
656
673
|
repositoryId: string;
|
|
@@ -670,10 +687,10 @@ export interface IEntriesClient {
|
|
|
670
687
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.
|
|
671
688
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
672
689
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
673
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
690
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
674
691
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
675
692
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
676
|
-
* @returns
|
|
693
|
+
* @returns Successfully returned field values for requested entry.
|
|
677
694
|
*/
|
|
678
695
|
listFields(args: {
|
|
679
696
|
repositoryId: string;
|
|
@@ -696,7 +713,7 @@ export interface IEntriesClient {
|
|
|
696
713
|
* @param args.entryId The entry ID of the entry that will have its fields updated.
|
|
697
714
|
* @param args.request The request body.
|
|
698
715
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
|
|
699
|
-
* @returns
|
|
716
|
+
* @returns Successfully updated field values on requested entry. Returned updated fields
|
|
700
717
|
*/
|
|
701
718
|
setFields(args: {
|
|
702
719
|
repositoryId: string;
|
|
@@ -714,10 +731,10 @@ export interface IEntriesClient {
|
|
|
714
731
|
* @param args.prefer (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
715
732
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
716
733
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
717
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
734
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
718
735
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
719
736
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
720
|
-
* @returns
|
|
737
|
+
* @returns Successfully returned tags for requested entry.
|
|
721
738
|
*/
|
|
722
739
|
listTags(args: {
|
|
723
740
|
repositoryId: string;
|
|
@@ -737,7 +754,7 @@ export interface IEntriesClient {
|
|
|
737
754
|
* @param args.repositoryId The requested repository ID.
|
|
738
755
|
* @param args.entryId The requested entry ID.
|
|
739
756
|
* @param args.request The tags to add.
|
|
740
|
-
* @returns
|
|
757
|
+
* @returns Successfully assigned tags to the requested entry. Returned updated tags.
|
|
741
758
|
*/
|
|
742
759
|
setTags(args: {
|
|
743
760
|
repositoryId: string;
|
|
@@ -752,7 +769,7 @@ export interface IEntriesClient {
|
|
|
752
769
|
* @param args.repositoryId The request repository ID.
|
|
753
770
|
* @param args.entryId The requested entry ID.
|
|
754
771
|
* @param args.request The request body.
|
|
755
|
-
* @returns
|
|
772
|
+
* @returns Successfully returned list of links assigned to requested entry.
|
|
756
773
|
*/
|
|
757
774
|
setLinks(args: {
|
|
758
775
|
repositoryId: string;
|
|
@@ -769,10 +786,10 @@ export interface IEntriesClient {
|
|
|
769
786
|
* @param args.prefer (optional) An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
770
787
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
771
788
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
772
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
789
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
773
790
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
774
791
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
775
|
-
* @returns
|
|
792
|
+
* @returns Successfully returned list of links assigned to requested entry.
|
|
776
793
|
*/
|
|
777
794
|
listLinks(args: {
|
|
778
795
|
repositoryId: string;
|
|
@@ -792,7 +809,7 @@ export interface IEntriesClient {
|
|
|
792
809
|
* @param args.entryId The folder ID that the entry will be created in.
|
|
793
810
|
* @param args.request The request body.
|
|
794
811
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.
|
|
795
|
-
* @returns
|
|
812
|
+
* @returns Entry was copied successfully. Returned copied entry.
|
|
796
813
|
*/
|
|
797
814
|
copyEntry(args: {
|
|
798
815
|
repositoryId: string;
|
|
@@ -800,12 +817,62 @@ export interface IEntriesClient {
|
|
|
800
817
|
request: CopyEntryRequest;
|
|
801
818
|
culture?: string | null | undefined;
|
|
802
819
|
}): Promise<Entry>;
|
|
820
|
+
/**
|
|
821
|
+
* - Updates the electronic document, image pages, and/or metadata of the specified document entry.
|
|
822
|
+
- At least one of `file`, `imageFiles`, or `metadata` must be provided.
|
|
823
|
+
- The `file` form field is optional. When provided, it replaces the electronic document or is imported as image pages, following the same rules as the import endpoint:
|
|
824
|
+
- If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if `importAsElectronicDocument=true`, the file replaces the existing electronic document. For supported edoc formats, `pdfOptions.generatePages` additionally produces server-rendered image pages, and `pdfOptions.generateText` triggers text extraction from the document (or OCR when the source is image-based).
|
|
825
|
+
- Otherwise (image extension with `importAsElectronicDocument=false`), the file is imported as image pages. `pdfOptions.generateText` triggers OCR for the resulting pages.
|
|
826
|
+
- A zero-byte file is rejected with 400. To delete the electronic document while preserving pages and metadata, use `DELETE /Document/Edoc`.
|
|
827
|
+
- The optional `imageFiles` form field accepts up to 10 image files (100 MB aggregate) that are appended as image pages. Set `generateImagePagesText=false` in the body to skip OCR for the pages added via `imageFiles` (default: true).
|
|
828
|
+
- `file` and `imageFiles` can be combined whenever the file is imported as the electronic document — i.e. non-image file types, or image file types with `importAsElectronicDocument=true`. The request returns 400 only when both are provided and the file would itself become image pages (image file type with `importAsElectronicDocument=false`).
|
|
829
|
+
- Metadata updates are additive — only fields, tags, and links specified in the request are changed; everything else is preserved. Use PUT /fields, PUT /tags, or PUT /links for replace semantics.
|
|
830
|
+
- Lock/checkout lifecycle: the endpoint executes all requested mutations inside a single lock scope so that only one version is produced. It detects the caller's starting state and preserves it — the caller's existing persistent lock and/or checkout are reused, and the endpoint adds only what's missing for atomicity (checking out when the document is under version control but not checked out, persistently locking when no plock is held). On success, anything the endpoint added is released in reverse order (unlock plock, then check in — creating one version). On error, the endpoint undoes what it acquired (delete plock, undo checkout — no partial version).
|
|
831
|
+
- If the document is checked out or persistently locked by another user, this endpoint returns 423 Locked.
|
|
832
|
+
- Required OAuth scope: repository.Write
|
|
833
|
+
* @param args.repositoryId The requested repository ID.
|
|
834
|
+
* @param args.entryId The requested document ID.
|
|
835
|
+
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
|
|
836
|
+
* @param args.file (optional) Optional. The electronic document or image file to apply to the existing document. If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, it replaces the existing electronic document. Otherwise (image extension with importAsElectronicDocument=false), it is imported as image pages. A zero-byte file is rejected with 400; use DELETE /Document/Edoc to remove the electronic document.
|
|
837
|
+
* @param args.request (optional)
|
|
838
|
+
* @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. On UpdateDocument, existing pages are preserved by default and deleted first when overwriteContent=true. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
|
|
839
|
+
* @returns Successfully updated the document. Returned the updated entry.
|
|
840
|
+
*/
|
|
841
|
+
updateDocument(args: {
|
|
842
|
+
repositoryId: string;
|
|
843
|
+
entryId: number;
|
|
844
|
+
culture?: string | null | undefined;
|
|
845
|
+
file?: FileParameter | undefined;
|
|
846
|
+
request?: UpdateDocumentRequest | undefined;
|
|
847
|
+
imageFiles?: FileParameter[] | undefined;
|
|
848
|
+
}): Promise<Entry>;
|
|
849
|
+
/**
|
|
850
|
+
* - Updates a document entry from previously uploaded parts. The parts are assembled server-side into a single file that is then applied to the existing document.
|
|
851
|
+
- The uploadId is obtained from the CreateMultipartUploadUrls response. The partETags are the ETag values returned by S3 when uploading each file chunk to the pre-signed upload URLs, and should be provided in the order of their associated upload URLs.
|
|
852
|
+
- Use this endpoint when the file exceeds the upload size or time limits of the synchronous PATCH /Document endpoint.
|
|
853
|
+
- The assembled file is applied as either the electronic document or image pages, following the same rules as the synchronous PATCH /Document:
|
|
854
|
+
- If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if `importAsElectronicDocument=true`, the file replaces the existing electronic document. For supported edoc formats, `pdfOptions.generatePages` additionally produces server-rendered image pages, and `pdfOptions.generateText` triggers text extraction from the document (or OCR when the source is image-based).
|
|
855
|
+
- Otherwise (image extension with `importAsElectronicDocument=false`), the file is imported as image pages. `pdfOptions.generateText` triggers OCR for the resulting pages.
|
|
856
|
+
- If `metadata` is provided, it additively updates the template, fields, tags, and links. Existing values not mentioned in the request are preserved.
|
|
857
|
+
- Returns 202 Accepted with a task ID. Poll the task endpoint for progress and completion.
|
|
858
|
+
- `imageFiles`, `generateImagePagesText`, and the `overwriteContent` query parameter are not supported on this endpoint; use the synchronous PATCH /Document to append image pages, OCR them automatically, or replace metadata wholesale.
|
|
859
|
+
- Required OAuth scope: repository.Write
|
|
860
|
+
* @param args.repositoryId The requested repository ID.
|
|
861
|
+
* @param args.entryId The requested document ID.
|
|
862
|
+
* @param args.request The request body containing the upload ID, part ETags, and optional metadata.
|
|
863
|
+
* @returns Successfully started the update document from uploaded parts operation. Returns a task ID for polling progress.
|
|
864
|
+
*/
|
|
865
|
+
updateDocumentUploadedParts(args: {
|
|
866
|
+
repositoryId: string;
|
|
867
|
+
entryId: number;
|
|
868
|
+
request: UpdateDocumentUploadedPartsRequest;
|
|
869
|
+
}): Promise<StartTaskResponse>;
|
|
803
870
|
/**
|
|
804
871
|
* - Delete the edoc associated with the provided entry ID.
|
|
805
872
|
- Required OAuth scope: repository.Write
|
|
806
873
|
* @param args.repositoryId The requested repository ID.
|
|
807
874
|
* @param args.entryId The requested document ID.
|
|
808
|
-
* @returns
|
|
875
|
+
* @returns Successfully deleted edoc associated with the specified entry. Returned the updated entry.
|
|
809
876
|
*/
|
|
810
877
|
deleteElectronicDocument(args: {
|
|
811
878
|
repositoryId: string;
|
|
@@ -818,13 +885,197 @@ export interface IEntriesClient {
|
|
|
818
885
|
* @param args.repositoryId The requested repository ID.
|
|
819
886
|
* @param args.entryId The requested document ID.
|
|
820
887
|
* @param args.pageRange (optional) The pages to be deleted.
|
|
821
|
-
* @returns
|
|
888
|
+
* @returns Successfully deleted pages associated with the specified entry. Returned the updated entry.
|
|
822
889
|
*/
|
|
823
890
|
deletePages(args: {
|
|
824
891
|
repositoryId: string;
|
|
825
892
|
entryId: number;
|
|
826
893
|
pageRange?: string | null | undefined;
|
|
827
894
|
}): Promise<Entry>;
|
|
895
|
+
/**
|
|
896
|
+
* - Creates one or more new pages in the specified document.
|
|
897
|
+
- Optional imageFiles form field: up to 10 image files, 100 MB aggregate.
|
|
898
|
+
- Optional textPages array in the request JSON part. Aggregate size must be below 100 MB.
|
|
899
|
+
- The two arrays are paired by index: page[i] gets imageFiles[i] and textPages[i].
|
|
900
|
+
- The number of pages created is max(imageFiles.Count, textPages.Count). If one array is shorter, pages beyond its length are created without that part.
|
|
901
|
+
- If neither imageFiles nor textPages is provided, one empty page is created.
|
|
902
|
+
- If pageNumber is omitted, pages are appended to the end. If provided, pages are inserted at that 1-based position; existing pages shift down.
|
|
903
|
+
- generateText triggers OCR when imageFiles are provided. When generateText is true and imageFiles are present, textPages is ignored because OCR-generated text would overwrite any provided text.
|
|
904
|
+
- Required OAuth scope: repository.Write
|
|
905
|
+
* @param args.repositoryId The requested repository ID.
|
|
906
|
+
* @param args.entryId The requested document ID.
|
|
907
|
+
* @param args.pageNumber (optional) Optional 1-based page number. If omitted, pages are appended to the end. If provided, pages are inserted at that position.
|
|
908
|
+
* @param args.generateText (optional) If true, triggers server-side text generation (OCR) for image pages. Default is false.
|
|
909
|
+
* @param args.request (optional)
|
|
910
|
+
* @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. On UpdateDocument, existing pages are preserved by default and deleted first when overwriteContent=true. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
|
|
911
|
+
* @returns Successfully created pages in the specified document. Returned the updated entry.
|
|
912
|
+
*/
|
|
913
|
+
createPages(args: {
|
|
914
|
+
repositoryId: string;
|
|
915
|
+
entryId: number;
|
|
916
|
+
pageNumber?: number | null | undefined;
|
|
917
|
+
generateText?: boolean | undefined;
|
|
918
|
+
request?: PagesContentRequest | undefined;
|
|
919
|
+
imageFiles?: FileParameter[] | undefined;
|
|
920
|
+
}): Promise<Entry>;
|
|
921
|
+
/**
|
|
922
|
+
* - Deletes all existing pages on the document, then creates new pages from the provided content. This is a single operation — one lock scope, one auto-version if the document is under version control.
|
|
923
|
+
- At least one `imageFile` or `textPage` must be provided. To delete all pages without replacement, use DELETE /Pages.
|
|
924
|
+
- The `imageFiles` and `textPages` arrays are paired by index (same rules as POST /Pages).
|
|
925
|
+
- Required OAuth scope: repository.Write
|
|
926
|
+
* @param args.repositoryId The requested repository ID.
|
|
927
|
+
* @param args.entryId The requested document ID.
|
|
928
|
+
* @param args.generateText (optional) If true, triggers server-side text generation (OCR) after creating pages. Default is false.
|
|
929
|
+
* @param args.request (optional)
|
|
930
|
+
* @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. On UpdateDocument, existing pages are preserved by default and deleted first when overwriteContent=true. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
|
|
931
|
+
* @returns Successfully replaced all pages in the specified document. Returned the updated entry.
|
|
932
|
+
*/
|
|
933
|
+
replacePages(args: {
|
|
934
|
+
repositoryId: string;
|
|
935
|
+
entryId: number;
|
|
936
|
+
generateText?: boolean | undefined;
|
|
937
|
+
request?: PagesContentRequest | undefined;
|
|
938
|
+
imageFiles?: FileParameter[] | undefined;
|
|
939
|
+
}): Promise<Entry>;
|
|
940
|
+
/**
|
|
941
|
+
* - Returns a list of page properties including image dimensions, rotation angle, and content flags.
|
|
942
|
+
- Pages are returned in ascending pageNumber order; that order is fixed and not configurable.
|
|
943
|
+
- Default page size: 150. Allowed OData query options: Select | Count | SkipToken | Top | Prefer.
|
|
944
|
+
- pageRange filters which pages are returned before paging is applied. Combine pageRange with $top/$skiptoken to paginate within a known range.
|
|
945
|
+
- Required OAuth scope: repository.Read
|
|
946
|
+
* @param args.repositoryId The requested repository ID.
|
|
947
|
+
* @param args.entryId The requested document ID.
|
|
948
|
+
* @param args.pageRange (optional) Optional comma-separated page numbers and ranges (e.g., "1,3-5,8-10"). Ranges must not overlap. When omitted, all pages are returned (subject to paging).
|
|
949
|
+
* @param args.prefer (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
950
|
+
* @param args.select (optional) Limits the properties returned in the result.
|
|
951
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
952
|
+
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
953
|
+
* @returns Successfully retrieved a paged listing of page information for the document.
|
|
954
|
+
*/
|
|
955
|
+
listPageInfos(args: {
|
|
956
|
+
repositoryId: string;
|
|
957
|
+
entryId: number;
|
|
958
|
+
pageRange?: string | null | undefined;
|
|
959
|
+
prefer?: string | null | undefined;
|
|
960
|
+
select?: string | null | undefined;
|
|
961
|
+
top?: number | undefined;
|
|
962
|
+
count?: boolean | undefined;
|
|
963
|
+
}): Promise<PageInfoCollectionResponse>;
|
|
964
|
+
/**
|
|
965
|
+
* - Overwrites the image and/or text part of the specified page. At least one of `imageFile` or `request` (with text) must be provided.
|
|
966
|
+
- Parts not provided are left unchanged — e.g. providing only `imageFile` replaces the image without affecting existing text.
|
|
967
|
+
- pageNumber is 1-based.
|
|
968
|
+
- Required OAuth scope: repository.Write
|
|
969
|
+
* @param args.repositoryId The requested repository ID.
|
|
970
|
+
* @param args.entryId The requested document ID.
|
|
971
|
+
* @param args.pageNumber The 1-based page number.
|
|
972
|
+
* @param args.generateText (optional) If true, triggers server-side text generation (OCR) after writing. Default is false.
|
|
973
|
+
* @param args.imageFile (optional) Optional. The image file to upload to replace the page's image content. See https://doc.laserfiche.com/ for supported image file formats. At least one of imageFile or request (with text) must be provided.
|
|
974
|
+
* @param args.request (optional)
|
|
975
|
+
* @returns Successfully wrote the image content of the specified page. Returned the updated entry.
|
|
976
|
+
*/
|
|
977
|
+
writePage(args: {
|
|
978
|
+
repositoryId: string;
|
|
979
|
+
entryId: number;
|
|
980
|
+
pageNumber: number;
|
|
981
|
+
generateText?: boolean | undefined;
|
|
982
|
+
imageFile?: FileParameter | undefined;
|
|
983
|
+
request?: WritePageTextRequest | undefined;
|
|
984
|
+
}): Promise<Entry>;
|
|
985
|
+
/**
|
|
986
|
+
* - Moves the specified pages within the same document to a new position.
|
|
987
|
+
- pageRange: A comma-separated string of non-overlapping single values or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12."
|
|
988
|
+
- destinationPageNumber: The 1-based page number where the pages will be moved before.
|
|
989
|
+
- Required OAuth scope: repository.Write
|
|
990
|
+
* @param args.repositoryId The requested repository ID.
|
|
991
|
+
* @param args.entryId The requested document ID.
|
|
992
|
+
* @param args.request The request body containing the page range and destination.
|
|
993
|
+
* @returns Successfully moved pages within the specified document. Returned the updated entry.
|
|
994
|
+
*/
|
|
995
|
+
movePages(args: {
|
|
996
|
+
repositoryId: string;
|
|
997
|
+
entryId: number;
|
|
998
|
+
request: MovePagesRequest;
|
|
999
|
+
}): Promise<Entry>;
|
|
1000
|
+
/**
|
|
1001
|
+
* - Copies the specified pages from the source document to the destination document.
|
|
1002
|
+
- The source document retains its pages; copies are inserted into the destination.
|
|
1003
|
+
- pageRange: A comma-separated string of non-overlapping single values or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12." The total number of distinct pages cannot exceed 500.
|
|
1004
|
+
- destinationEntryId: The entry ID of the destination document.
|
|
1005
|
+
- destinationPageNumber: The 1-based page number in the destination document where pages will be inserted before.
|
|
1006
|
+
- Required OAuth scope: repository.Write
|
|
1007
|
+
* @param args.repositoryId The requested repository ID.
|
|
1008
|
+
* @param args.entryId The source document ID.
|
|
1009
|
+
* @param args.request The request body containing the page range, destination entry ID, and destination page number.
|
|
1010
|
+
* @returns Successfully copied pages from the source document to the destination document. The source document retains its pages. Returned the updated source entry.
|
|
1011
|
+
*/
|
|
1012
|
+
copyPages(args: {
|
|
1013
|
+
repositoryId: string;
|
|
1014
|
+
entryId: number;
|
|
1015
|
+
request: CopyPagesRequest;
|
|
1016
|
+
}): Promise<Entry>;
|
|
1017
|
+
/**
|
|
1018
|
+
* - Rotates the image of the specified page by the given angle.
|
|
1019
|
+
- rotationAngle: The rotation angle in degrees. Accepted values: 0, 90, 180, 270.
|
|
1020
|
+
- pageNumber is 1-based.
|
|
1021
|
+
- Required OAuth scope: repository.Write
|
|
1022
|
+
* @param args.repositoryId The requested repository ID.
|
|
1023
|
+
* @param args.entryId The requested document ID.
|
|
1024
|
+
* @param args.pageNumber The 1-based page number of the page to rotate.
|
|
1025
|
+
* @param args.request The request body containing the rotation angle.
|
|
1026
|
+
* @returns Successfully rotated the image page. Returned the updated entry.
|
|
1027
|
+
*/
|
|
1028
|
+
rotateImagePage(args: {
|
|
1029
|
+
repositoryId: string;
|
|
1030
|
+
entryId: number;
|
|
1031
|
+
pageNumber: number;
|
|
1032
|
+
request: RotateImagePageRequest;
|
|
1033
|
+
}): Promise<Entry>;
|
|
1034
|
+
/**
|
|
1035
|
+
* - Returns the raw image data for the specified page as a binary stream.
|
|
1036
|
+
- pageNumber is 1-based.
|
|
1037
|
+
- Required OAuth scope: repository.Read
|
|
1038
|
+
* @param args.repositoryId The requested repository ID.
|
|
1039
|
+
* @param args.entryId The requested document ID.
|
|
1040
|
+
* @param args.pageNumber The 1-based page number of the page to retrieve the image for.
|
|
1041
|
+
* @param args.select (optional) Limits the properties returned in the result.
|
|
1042
|
+
* @returns Successfully retrieved the image content for the specified page.
|
|
1043
|
+
*/
|
|
1044
|
+
getPageImage(args: {
|
|
1045
|
+
repositoryId: string;
|
|
1046
|
+
entryId: number;
|
|
1047
|
+
pageNumber: number;
|
|
1048
|
+
select?: string | null | undefined;
|
|
1049
|
+
}): Promise<FileResponse>;
|
|
1050
|
+
/**
|
|
1051
|
+
* - Returns the text content for the specified page.
|
|
1052
|
+
- pageNumber is 1-based.
|
|
1053
|
+
- Required OAuth scope: repository.Read
|
|
1054
|
+
* @param args.repositoryId The requested repository ID.
|
|
1055
|
+
* @param args.entryId The requested document ID.
|
|
1056
|
+
* @param args.pageNumber The 1-based page number of the page to retrieve the text for.
|
|
1057
|
+
* @param args.select (optional) Limits the properties returned in the result.
|
|
1058
|
+
* @returns Successfully retrieved the text content for the specified page.
|
|
1059
|
+
*/
|
|
1060
|
+
getPageText(args: {
|
|
1061
|
+
repositoryId: string;
|
|
1062
|
+
entryId: number;
|
|
1063
|
+
pageNumber: number;
|
|
1064
|
+
select?: string | null | undefined;
|
|
1065
|
+
}): Promise<PageTextResponse>;
|
|
1066
|
+
/**
|
|
1067
|
+
* - Triggers server-side text generation for the specified document.
|
|
1068
|
+
- For documents with image pages, this performs OCR to generate searchable text.
|
|
1069
|
+
- For documents with an electronic document part (e.g., PDF), this extracts embedded text.
|
|
1070
|
+
- Required OAuth scope: repository.Write
|
|
1071
|
+
* @param args.repositoryId The requested repository ID.
|
|
1072
|
+
* @param args.entryId The requested document ID.
|
|
1073
|
+
* @returns Successfully triggered text generation for the document. Returned the updated entry.
|
|
1074
|
+
*/
|
|
1075
|
+
generateText(args: {
|
|
1076
|
+
repositoryId: string;
|
|
1077
|
+
entryId: number;
|
|
1078
|
+
}): Promise<Entry>;
|
|
828
1079
|
/**
|
|
829
1080
|
* - Returns dynamic field logic values with the current values of the fields in the template.
|
|
830
1081
|
- Provide an entry ID and field values in the JSON body to get dynamic field logic values.
|
|
@@ -833,7 +1084,7 @@ export interface IEntriesClient {
|
|
|
833
1084
|
* @param args.repositoryId The requested repository ID.
|
|
834
1085
|
* @param args.entryId The requested entry ID.
|
|
835
1086
|
* @param args.request The request body.
|
|
836
|
-
* @returns
|
|
1087
|
+
* @returns Successfully returned dynamic field values for specified entry, template, and field values.
|
|
837
1088
|
*/
|
|
838
1089
|
listDynamicFieldValues(args: {
|
|
839
1090
|
repositoryId: string;
|
|
@@ -849,7 +1100,7 @@ export interface IEntriesClient {
|
|
|
849
1100
|
- Required OAuth scope: repository.Write
|
|
850
1101
|
* @param args.repositoryId The requested repository ID.
|
|
851
1102
|
* @param args.entryId The ID of the entry that will have its template removed.
|
|
852
|
-
* @returns
|
|
1103
|
+
* @returns Successfully removed the currently assigned template from requested entry. Returned updated entry.
|
|
853
1104
|
*/
|
|
854
1105
|
removeTemplate(args: {
|
|
855
1106
|
repositoryId: string;
|
|
@@ -864,7 +1115,7 @@ export interface IEntriesClient {
|
|
|
864
1115
|
* @param args.entryId The ID of entry that will have its template updated.
|
|
865
1116
|
* @param args.request The template and template fields that will be assigned to the entry.
|
|
866
1117
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
|
|
867
|
-
* @returns
|
|
1118
|
+
* @returns Successfully assigned specified template to requested entry. Returned updated entry.
|
|
868
1119
|
*/
|
|
869
1120
|
setTemplate(args: {
|
|
870
1121
|
repositoryId: string;
|
|
@@ -872,6 +1123,105 @@ export interface IEntriesClient {
|
|
|
872
1123
|
request: SetTemplateRequest;
|
|
873
1124
|
culture?: string | null | undefined;
|
|
874
1125
|
}): Promise<Entry>;
|
|
1126
|
+
/**
|
|
1127
|
+
* - Creates a persistent lock on the specified document. Persistent locks survive session disconnect and server restart.
|
|
1128
|
+
- Optionally specify a comment and lock extent (Page, Edoc, Metadata, or All). Defaults to All.
|
|
1129
|
+
- Returns lock info including the lock token, owner, and extent.
|
|
1130
|
+
- Required OAuth scope: repository.Write
|
|
1131
|
+
* @param args.repositoryId The requested repository ID.
|
|
1132
|
+
* @param args.entryId The requested document ID.
|
|
1133
|
+
* @param args.request (optional) The request body containing optional lock comment and extent.
|
|
1134
|
+
* @returns Successfully created a persistent lock on the document.
|
|
1135
|
+
*/
|
|
1136
|
+
lockDocument(args: {
|
|
1137
|
+
repositoryId: string;
|
|
1138
|
+
entryId: number;
|
|
1139
|
+
request?: LockDocumentRequest | undefined;
|
|
1140
|
+
}): Promise<LockInfo>;
|
|
1141
|
+
/**
|
|
1142
|
+
* - Returns the current persistent lock state of the document, including who holds the lock, the lock token, comment, extent, and creation timestamp.
|
|
1143
|
+
- If the document is not locked, returns lock info with isActive set to false.
|
|
1144
|
+
- Required OAuth scope: repository.Read
|
|
1145
|
+
* @param args.repositoryId The requested repository ID.
|
|
1146
|
+
* @param args.entryId The requested document ID.
|
|
1147
|
+
* @param args.select (optional) Limits the properties returned in the result.
|
|
1148
|
+
* @returns Successfully returned the lock state of the document.
|
|
1149
|
+
*/
|
|
1150
|
+
getDocumentLockInfo(args: {
|
|
1151
|
+
repositoryId: string;
|
|
1152
|
+
entryId: number;
|
|
1153
|
+
select?: string | null | undefined;
|
|
1154
|
+
}): Promise<LockInfo>;
|
|
1155
|
+
/**
|
|
1156
|
+
* - Without a lockToken query parameter, removes the current user's persistent lock on the document.
|
|
1157
|
+
- With a lockToken query parameter, removes the specified lock regardless of owner (administrative unlock).
|
|
1158
|
+
- Required OAuth scope: repository.Write
|
|
1159
|
+
* @param args.repositoryId The requested repository ID.
|
|
1160
|
+
* @param args.entryId The requested document ID.
|
|
1161
|
+
* @param args.lockToken (optional) Optional lock token to unlock a specific lock held by another user (administrative unlock).
|
|
1162
|
+
* @returns Successfully removed the persistent lock from the document.
|
|
1163
|
+
*/
|
|
1164
|
+
unlockDocument(args: {
|
|
1165
|
+
repositoryId: string;
|
|
1166
|
+
entryId: number;
|
|
1167
|
+
lockToken?: string | null | undefined;
|
|
1168
|
+
}): Promise<void>;
|
|
1169
|
+
/**
|
|
1170
|
+
* - Puts the specified document under version control. No-op if already under version control.
|
|
1171
|
+
- Documents must be under version control before they can be checked out.
|
|
1172
|
+
- Required OAuth scope: repository.Write
|
|
1173
|
+
* @param args.repositoryId The requested repository ID.
|
|
1174
|
+
* @param args.entryId The requested document ID.
|
|
1175
|
+
* @returns Successfully put the document under version control.
|
|
1176
|
+
*/
|
|
1177
|
+
putUnderVersionControl(args: {
|
|
1178
|
+
repositoryId: string;
|
|
1179
|
+
entryId: number;
|
|
1180
|
+
}): Promise<Entry>;
|
|
1181
|
+
/**
|
|
1182
|
+
* - Checks out the specified document for editing. The document must be under version control.
|
|
1183
|
+
- By default, a persistent lock is automatically acquired (lock=true). Set lock=false to check out without locking.
|
|
1184
|
+
- Optionally specify a comment for the check-out.
|
|
1185
|
+
- Returns an error if the document is not under version control.
|
|
1186
|
+
- Required OAuth scope: repository.Write
|
|
1187
|
+
* @param args.repositoryId The requested repository ID.
|
|
1188
|
+
* @param args.entryId The requested document ID.
|
|
1189
|
+
* @param args.request (optional) The request body containing optional lock and comment parameters.
|
|
1190
|
+
* @returns Successfully checked out the document.
|
|
1191
|
+
*/
|
|
1192
|
+
checkOutDocument(args: {
|
|
1193
|
+
repositoryId: string;
|
|
1194
|
+
entryId: number;
|
|
1195
|
+
request?: CheckOutDocumentRequest | undefined;
|
|
1196
|
+
}): Promise<Entry>;
|
|
1197
|
+
/**
|
|
1198
|
+
* - Checks in the specified document, creating a new version in the version history.
|
|
1199
|
+
- By default, releases the persistent lock if one is held. Set unlock to false to keep the lock.
|
|
1200
|
+
- Returns an error if the document is not currently checked out.
|
|
1201
|
+
- Required OAuth scope: repository.Write
|
|
1202
|
+
* @param args.repositoryId The requested repository ID.
|
|
1203
|
+
* @param args.entryId The requested document ID.
|
|
1204
|
+
* @param args.request (optional) Optional request body. If omitted, the persistent lock is released (default behavior).
|
|
1205
|
+
* @returns Successfully checked in the document. If a persistent lock was held and unlock was not set to false, the lock has been released.
|
|
1206
|
+
*/
|
|
1207
|
+
checkInDocument(args: {
|
|
1208
|
+
repositoryId: string;
|
|
1209
|
+
entryId: number;
|
|
1210
|
+
request?: CheckInDocumentRequest | undefined;
|
|
1211
|
+
}): Promise<Entry>;
|
|
1212
|
+
/**
|
|
1213
|
+
* - Releases the check-out state without creating a new version in the version history.
|
|
1214
|
+
- Always releases the persistent lock if one is held.
|
|
1215
|
+
- Returns an error if the document is not under version control.
|
|
1216
|
+
- Required OAuth scope: repository.Write
|
|
1217
|
+
* @param args.repositoryId The requested repository ID.
|
|
1218
|
+
* @param args.entryId The requested document ID.
|
|
1219
|
+
* @returns Successfully undid the document check-out. Any persistent lock held on the document has been released.
|
|
1220
|
+
*/
|
|
1221
|
+
undoCheckOut(args: {
|
|
1222
|
+
repositoryId: string;
|
|
1223
|
+
entryId: number;
|
|
1224
|
+
}): Promise<Entry>;
|
|
875
1225
|
}
|
|
876
1226
|
export declare class EntriesClient implements IEntriesClient {
|
|
877
1227
|
private http;
|
|
@@ -1057,7 +1407,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1057
1407
|
- Required OAuth scope: repository.Write
|
|
1058
1408
|
* @param args.repositoryId The requested repository ID.
|
|
1059
1409
|
* @param args.request The request body.
|
|
1060
|
-
* @returns
|
|
1410
|
+
* @returns Returned response containing an upload ID and an array of upload URLs.
|
|
1061
1411
|
*/
|
|
1062
1412
|
createMultipartUploadUrls(args: {
|
|
1063
1413
|
repositoryId: string;
|
|
@@ -1065,14 +1415,21 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1065
1415
|
}): Promise<CreateMultipartUploadUrlsResponse>;
|
|
1066
1416
|
protected processCreateMultipartUploadUrls(response: Response): Promise<CreateMultipartUploadUrlsResponse>;
|
|
1067
1417
|
/**
|
|
1068
|
-
* - Imports a new
|
|
1069
|
-
-
|
|
1418
|
+
* - Imports a new document from previously uploaded parts into the specified folder. The parts are assembled server-side into a single file that is then processed like a direct import.
|
|
1419
|
+
- The uploadId is obtained from the CreateMultipartUploadUrls response. The partETags are the ETag values returned by S3 when uploading each file chunk to the pre-signed upload URLs, and should be provided in the order of their associated upload URLs.
|
|
1420
|
+
- The assembled file is imported as either the electronic document or image pages, following the same rules as the synchronous POST /Folder/Import:
|
|
1421
|
+
- If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if `importAsElectronicDocument=true`, the file is stored as the electronic document. For supported edoc formats, `pdfOptions.generatePages` additionally produces server-rendered image pages, and `pdfOptions.generateText` triggers text extraction from the document (or OCR when the source is image-based).
|
|
1422
|
+
- Otherwise (image extension with `importAsElectronicDocument=false`), the file is imported as image pages. `pdfOptions.generateText` triggers OCR for the resulting pages.
|
|
1423
|
+
- Metadata in the body is assigned to the newly created entry.
|
|
1424
|
+
- Supports assembled files up to 64 GB — use this endpoint when the file exceeds the size or time limits of the synchronous POST /Folder/Import.
|
|
1425
|
+
- Returns 202 Accepted with a task ID. Poll the task endpoint for progress and completion. This route does not support partial success.
|
|
1426
|
+
- `imageFiles` and `generateImagePagesText` are not supported on this endpoint; use the synchronous POST /Folder/Import to attach image pages alongside the imported file.
|
|
1070
1427
|
- Required OAuth scope: repository.Write
|
|
1071
1428
|
* @param args.repositoryId The requested repository ID.
|
|
1072
1429
|
* @param args.entryId The entry ID of the folder that the document will be created in.
|
|
1073
1430
|
* @param args.request (optional) The request body.
|
|
1074
1431
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
|
|
1075
|
-
* @returns
|
|
1432
|
+
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
1076
1433
|
*/
|
|
1077
1434
|
startImportUploadedParts(args: {
|
|
1078
1435
|
repositoryId: string;
|
|
@@ -1089,7 +1446,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1089
1446
|
* @param args.entryId The ID of entry to export.
|
|
1090
1447
|
* @param args.request The request body.
|
|
1091
1448
|
* @param args.pageRange (optional) A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when part=Edoc.
|
|
1092
|
-
* @returns
|
|
1449
|
+
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
1093
1450
|
*/
|
|
1094
1451
|
startExportEntry(args: {
|
|
1095
1452
|
repositoryId: string;
|
|
@@ -1108,7 +1465,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1108
1465
|
* @param args.entryId The folder ID that the entry will be created in.
|
|
1109
1466
|
* @param args.request The request body.
|
|
1110
1467
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.
|
|
1111
|
-
* @returns
|
|
1468
|
+
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
1112
1469
|
*/
|
|
1113
1470
|
startCopyEntry(args: {
|
|
1114
1471
|
repositoryId: string;
|
|
@@ -1125,7 +1482,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1125
1482
|
* @param args.repositoryId The requested repository ID.
|
|
1126
1483
|
* @param args.entryId The requested entry ID.
|
|
1127
1484
|
* @param args.request (optional) The submitted audit reason.
|
|
1128
|
-
* @returns
|
|
1485
|
+
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
1129
1486
|
*/
|
|
1130
1487
|
startDeleteEntry(args: {
|
|
1131
1488
|
repositoryId: string;
|
|
@@ -1136,13 +1493,14 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1136
1493
|
/**
|
|
1137
1494
|
* - Returns a single entry object.
|
|
1138
1495
|
- Provide an entry ID, and get the entry associated with that ID. Useful when detailed information about the entry is required, such as metadata, path information, etc.
|
|
1139
|
-
- If the entry is a subtype (Folder, Document, or Shortcut), the
|
|
1496
|
+
- If the entry is a subtype (Folder, Document, or Shortcut), the response will automatically include properties specific to that entry type. For example, Document entries include page-related properties such as the number of image pages and whether an electronic document is attached. Entries with an electronic document component include the electronic document size (in bytes). Folder entries include whether the folder is a record series. Shortcut entries include the target entry ID.
|
|
1140
1497
|
- Allowed OData query options: Select.
|
|
1498
|
+
- When OData Select query option is used, 'entryType' is always included in the result.
|
|
1141
1499
|
- Required OAuth scope: repository.Read
|
|
1142
1500
|
* @param args.repositoryId The requested repository ID.
|
|
1143
1501
|
* @param args.entryId The requested entry ID.
|
|
1144
1502
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1145
|
-
* @returns
|
|
1503
|
+
* @returns Successfully retrieved requested entry.
|
|
1146
1504
|
*/
|
|
1147
1505
|
getEntry(args: {
|
|
1148
1506
|
repositoryId: string;
|
|
@@ -1159,7 +1517,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1159
1517
|
* @param args.entryId The requested entry ID.
|
|
1160
1518
|
* @param args.request The request containing the folder ID that the entry will be moved to and the new name the entry will be renamed to.
|
|
1161
1519
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.
|
|
1162
|
-
* @returns
|
|
1520
|
+
* @returns Succesfully moved and/or renamed the entry. Returned updated entry.
|
|
1163
1521
|
*/
|
|
1164
1522
|
updateEntry(args: {
|
|
1165
1523
|
repositoryId: string;
|
|
@@ -1169,15 +1527,23 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1169
1527
|
}): Promise<Entry>;
|
|
1170
1528
|
protected processUpdateEntry(response: Response): Promise<Entry>;
|
|
1171
1529
|
/**
|
|
1172
|
-
* -
|
|
1173
|
-
- The
|
|
1530
|
+
* - Imports a new document into the specified folder, optionally with electronic document content, image pages, and metadata.
|
|
1531
|
+
- The `file` form field is optional. When provided, it becomes either the electronic document or image pages of the new document:
|
|
1532
|
+
- If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if `importAsElectronicDocument=true`, the file is stored as the electronic document. For supported edoc formats, `pdfOptions.generatePages` additionally produces server-rendered image pages, and `pdfOptions.generateText` triggers text extraction from the document (or OCR when the source is image-based).
|
|
1533
|
+
- Otherwise (image extension with `importAsElectronicDocument=false`), the file is imported as image pages. A multi-page TIFF produces multiple pages. `pdfOptions.generateText` triggers OCR for the resulting pages.
|
|
1534
|
+
- A zero-byte file creates an empty document with no electronic document and no pages.
|
|
1535
|
+
- The optional `imageFiles` form field accepts up to 10 image files (100 MB aggregate) that are appended as image pages. Set `generateImagePagesText=false` in the body to skip OCR for the pages added via `imageFiles` (default: true).
|
|
1536
|
+
- `file` and `imageFiles` can be combined whenever the file is imported as the electronic document — i.e. non-image file types, or image file types with `importAsElectronicDocument=true`. The request returns 400 only when both are provided and the file would itself become image pages (image file type with `importAsElectronicDocument=false`).
|
|
1537
|
+
- Metadata in the body is assigned to the newly created entry.
|
|
1538
|
+
- Size and time limits: file must be ≤ 100 MB and the request must complete within 60 seconds. These limits may change. Use the asynchronous long-operation import endpoint for larger files or slower imports.
|
|
1174
1539
|
- Required OAuth scope: repository.Write
|
|
1175
1540
|
* @param args.repositoryId The requested repository ID.
|
|
1176
1541
|
* @param args.entryId The entry ID of the folder that the document will be created in.
|
|
1177
1542
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
|
|
1178
|
-
* @param args.file (optional)
|
|
1543
|
+
* @param args.file (optional) Optional. The file to import. If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, it is stored as the electronic document. Otherwise (image extension with importAsElectronicDocument=false), it is imported as image pages. A zero-byte file creates an empty document with no electronic document and no pages.
|
|
1179
1544
|
* @param args.request (optional)
|
|
1180
|
-
* @
|
|
1545
|
+
* @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. On UpdateDocument, existing pages are preserved by default and deleted first when overwriteContent=true. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
|
|
1546
|
+
* @returns Document was created successfully. Returns created entry.
|
|
1181
1547
|
*/
|
|
1182
1548
|
importEntry(args: {
|
|
1183
1549
|
repositoryId: string;
|
|
@@ -1185,6 +1551,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1185
1551
|
culture?: string | null | undefined;
|
|
1186
1552
|
file?: FileParameter | undefined;
|
|
1187
1553
|
request?: ImportEntryRequest | undefined;
|
|
1554
|
+
imageFiles?: FileParameter[] | undefined;
|
|
1188
1555
|
}): Promise<Entry>;
|
|
1189
1556
|
protected processImportEntry(response: Response): Promise<Entry>;
|
|
1190
1557
|
/**
|
|
@@ -1195,7 +1562,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1195
1562
|
* @param args.entryId The ID of entry to export.
|
|
1196
1563
|
* @param args.request The request body.
|
|
1197
1564
|
* @param args.pageRange (optional) A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc.
|
|
1198
|
-
* @returns
|
|
1565
|
+
* @returns Export was successful. Returned a link to download the exported entry.
|
|
1199
1566
|
*/
|
|
1200
1567
|
exportEntry(args: {
|
|
1201
1568
|
repositoryId: string;
|
|
@@ -1211,7 +1578,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1211
1578
|
* @param args.repositoryId The requested repository ID.
|
|
1212
1579
|
* @param args.fullPath The requested entry path.
|
|
1213
1580
|
* @param args.fallbackToClosestAncestor (optional) An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false.
|
|
1214
|
-
* @returns
|
|
1581
|
+
* @returns Successfully retrieved requested entry or ancestor entry.
|
|
1215
1582
|
*/
|
|
1216
1583
|
getEntryByPath(args: {
|
|
1217
1584
|
repositoryId: string;
|
|
@@ -1236,10 +1603,10 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1236
1603
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.
|
|
1237
1604
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1238
1605
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
1239
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
1606
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
1240
1607
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
1241
1608
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
1242
|
-
* @returns
|
|
1609
|
+
* @returns Successfully returned list of children entries in requested folder.
|
|
1243
1610
|
*/
|
|
1244
1611
|
listEntries(args: {
|
|
1245
1612
|
repositoryId: string;
|
|
@@ -1264,7 +1631,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1264
1631
|
* @param args.entryId The folder ID that the entry will be created in.
|
|
1265
1632
|
* @param args.request The request body.
|
|
1266
1633
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.
|
|
1267
|
-
* @returns
|
|
1634
|
+
* @returns Document was created successfully. Returns created entry.
|
|
1268
1635
|
*/
|
|
1269
1636
|
createEntry(args: {
|
|
1270
1637
|
repositoryId: string;
|
|
@@ -1285,10 +1652,10 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1285
1652
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.
|
|
1286
1653
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1287
1654
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
1288
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
1655
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
1289
1656
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
1290
1657
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
1291
|
-
* @returns
|
|
1658
|
+
* @returns Successfully returned field values for requested entry.
|
|
1292
1659
|
*/
|
|
1293
1660
|
listFields(args: {
|
|
1294
1661
|
repositoryId: string;
|
|
@@ -1312,7 +1679,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1312
1679
|
* @param args.entryId The entry ID of the entry that will have its fields updated.
|
|
1313
1680
|
* @param args.request The request body.
|
|
1314
1681
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
|
|
1315
|
-
* @returns
|
|
1682
|
+
* @returns Successfully updated field values on requested entry. Returned updated fields
|
|
1316
1683
|
*/
|
|
1317
1684
|
setFields(args: {
|
|
1318
1685
|
repositoryId: string;
|
|
@@ -1331,10 +1698,10 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1331
1698
|
* @param args.prefer (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
1332
1699
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1333
1700
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
1334
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
1701
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
1335
1702
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
1336
1703
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
1337
|
-
* @returns
|
|
1704
|
+
* @returns Successfully returned tags for requested entry.
|
|
1338
1705
|
*/
|
|
1339
1706
|
listTags(args: {
|
|
1340
1707
|
repositoryId: string;
|
|
@@ -1355,7 +1722,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1355
1722
|
* @param args.repositoryId The requested repository ID.
|
|
1356
1723
|
* @param args.entryId The requested entry ID.
|
|
1357
1724
|
* @param args.request The tags to add.
|
|
1358
|
-
* @returns
|
|
1725
|
+
* @returns Successfully assigned tags to the requested entry. Returned updated tags.
|
|
1359
1726
|
*/
|
|
1360
1727
|
setTags(args: {
|
|
1361
1728
|
repositoryId: string;
|
|
@@ -1371,7 +1738,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1371
1738
|
* @param args.repositoryId The request repository ID.
|
|
1372
1739
|
* @param args.entryId The requested entry ID.
|
|
1373
1740
|
* @param args.request The request body.
|
|
1374
|
-
* @returns
|
|
1741
|
+
* @returns Successfully returned list of links assigned to requested entry.
|
|
1375
1742
|
*/
|
|
1376
1743
|
setLinks(args: {
|
|
1377
1744
|
repositoryId: string;
|
|
@@ -1389,10 +1756,10 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1389
1756
|
* @param args.prefer (optional) An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
1390
1757
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1391
1758
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
1392
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
1759
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
1393
1760
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
1394
1761
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
1395
|
-
* @returns
|
|
1762
|
+
* @returns Successfully returned list of links assigned to requested entry.
|
|
1396
1763
|
*/
|
|
1397
1764
|
listLinks(args: {
|
|
1398
1765
|
repositoryId: string;
|
|
@@ -1413,7 +1780,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1413
1780
|
* @param args.entryId The folder ID that the entry will be created in.
|
|
1414
1781
|
* @param args.request The request body.
|
|
1415
1782
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.
|
|
1416
|
-
* @returns
|
|
1783
|
+
* @returns Entry was copied successfully. Returned copied entry.
|
|
1417
1784
|
*/
|
|
1418
1785
|
copyEntry(args: {
|
|
1419
1786
|
repositoryId: string;
|
|
@@ -1422,12 +1789,64 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1422
1789
|
culture?: string | null | undefined;
|
|
1423
1790
|
}): Promise<Entry>;
|
|
1424
1791
|
protected processCopyEntry(response: Response): Promise<Entry>;
|
|
1792
|
+
/**
|
|
1793
|
+
* - Updates the electronic document, image pages, and/or metadata of the specified document entry.
|
|
1794
|
+
- At least one of `file`, `imageFiles`, or `metadata` must be provided.
|
|
1795
|
+
- The `file` form field is optional. When provided, it replaces the electronic document or is imported as image pages, following the same rules as the import endpoint:
|
|
1796
|
+
- If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if `importAsElectronicDocument=true`, the file replaces the existing electronic document. For supported edoc formats, `pdfOptions.generatePages` additionally produces server-rendered image pages, and `pdfOptions.generateText` triggers text extraction from the document (or OCR when the source is image-based).
|
|
1797
|
+
- Otherwise (image extension with `importAsElectronicDocument=false`), the file is imported as image pages. `pdfOptions.generateText` triggers OCR for the resulting pages.
|
|
1798
|
+
- A zero-byte file is rejected with 400. To delete the electronic document while preserving pages and metadata, use `DELETE /Document/Edoc`.
|
|
1799
|
+
- The optional `imageFiles` form field accepts up to 10 image files (100 MB aggregate) that are appended as image pages. Set `generateImagePagesText=false` in the body to skip OCR for the pages added via `imageFiles` (default: true).
|
|
1800
|
+
- `file` and `imageFiles` can be combined whenever the file is imported as the electronic document — i.e. non-image file types, or image file types with `importAsElectronicDocument=true`. The request returns 400 only when both are provided and the file would itself become image pages (image file type with `importAsElectronicDocument=false`).
|
|
1801
|
+
- Metadata updates are additive — only fields, tags, and links specified in the request are changed; everything else is preserved. Use PUT /fields, PUT /tags, or PUT /links for replace semantics.
|
|
1802
|
+
- Lock/checkout lifecycle: the endpoint executes all requested mutations inside a single lock scope so that only one version is produced. It detects the caller's starting state and preserves it — the caller's existing persistent lock and/or checkout are reused, and the endpoint adds only what's missing for atomicity (checking out when the document is under version control but not checked out, persistently locking when no plock is held). On success, anything the endpoint added is released in reverse order (unlock plock, then check in — creating one version). On error, the endpoint undoes what it acquired (delete plock, undo checkout — no partial version).
|
|
1803
|
+
- If the document is checked out or persistently locked by another user, this endpoint returns 423 Locked.
|
|
1804
|
+
- Required OAuth scope: repository.Write
|
|
1805
|
+
* @param args.repositoryId The requested repository ID.
|
|
1806
|
+
* @param args.entryId The requested document ID.
|
|
1807
|
+
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
|
|
1808
|
+
* @param args.file (optional) Optional. The electronic document or image file to apply to the existing document. If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if importAsElectronicDocument=true, it replaces the existing electronic document. Otherwise (image extension with importAsElectronicDocument=false), it is imported as image pages. A zero-byte file is rejected with 400; use DELETE /Document/Edoc to remove the electronic document.
|
|
1809
|
+
* @param args.request (optional)
|
|
1810
|
+
* @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. On UpdateDocument, existing pages are preserved by default and deleted first when overwriteContent=true. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
|
|
1811
|
+
* @returns Successfully updated the document. Returned the updated entry.
|
|
1812
|
+
*/
|
|
1813
|
+
updateDocument(args: {
|
|
1814
|
+
repositoryId: string;
|
|
1815
|
+
entryId: number;
|
|
1816
|
+
culture?: string | null | undefined;
|
|
1817
|
+
file?: FileParameter | undefined;
|
|
1818
|
+
request?: UpdateDocumentRequest | undefined;
|
|
1819
|
+
imageFiles?: FileParameter[] | undefined;
|
|
1820
|
+
}): Promise<Entry>;
|
|
1821
|
+
protected processUpdateDocument(response: Response): Promise<Entry>;
|
|
1822
|
+
/**
|
|
1823
|
+
* - Updates a document entry from previously uploaded parts. The parts are assembled server-side into a single file that is then applied to the existing document.
|
|
1824
|
+
- The uploadId is obtained from the CreateMultipartUploadUrls response. The partETags are the ETag values returned by S3 when uploading each file chunk to the pre-signed upload URLs, and should be provided in the order of their associated upload URLs.
|
|
1825
|
+
- Use this endpoint when the file exceeds the upload size or time limits of the synchronous PATCH /Document endpoint.
|
|
1826
|
+
- The assembled file is applied as either the electronic document or image pages, following the same rules as the synchronous PATCH /Document:
|
|
1827
|
+
- If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if `importAsElectronicDocument=true`, the file replaces the existing electronic document. For supported edoc formats, `pdfOptions.generatePages` additionally produces server-rendered image pages, and `pdfOptions.generateText` triggers text extraction from the document (or OCR when the source is image-based).
|
|
1828
|
+
- Otherwise (image extension with `importAsElectronicDocument=false`), the file is imported as image pages. `pdfOptions.generateText` triggers OCR for the resulting pages.
|
|
1829
|
+
- If `metadata` is provided, it additively updates the template, fields, tags, and links. Existing values not mentioned in the request are preserved.
|
|
1830
|
+
- Returns 202 Accepted with a task ID. Poll the task endpoint for progress and completion.
|
|
1831
|
+
- `imageFiles`, `generateImagePagesText`, and the `overwriteContent` query parameter are not supported on this endpoint; use the synchronous PATCH /Document to append image pages, OCR them automatically, or replace metadata wholesale.
|
|
1832
|
+
- Required OAuth scope: repository.Write
|
|
1833
|
+
* @param args.repositoryId The requested repository ID.
|
|
1834
|
+
* @param args.entryId The requested document ID.
|
|
1835
|
+
* @param args.request The request body containing the upload ID, part ETags, and optional metadata.
|
|
1836
|
+
* @returns Successfully started the update document from uploaded parts operation. Returns a task ID for polling progress.
|
|
1837
|
+
*/
|
|
1838
|
+
updateDocumentUploadedParts(args: {
|
|
1839
|
+
repositoryId: string;
|
|
1840
|
+
entryId: number;
|
|
1841
|
+
request: UpdateDocumentUploadedPartsRequest;
|
|
1842
|
+
}): Promise<StartTaskResponse>;
|
|
1843
|
+
protected processUpdateDocumentUploadedParts(response: Response): Promise<StartTaskResponse>;
|
|
1425
1844
|
/**
|
|
1426
1845
|
* - Delete the edoc associated with the provided entry ID.
|
|
1427
1846
|
- Required OAuth scope: repository.Write
|
|
1428
1847
|
* @param args.repositoryId The requested repository ID.
|
|
1429
1848
|
* @param args.entryId The requested document ID.
|
|
1430
|
-
* @returns
|
|
1849
|
+
* @returns Successfully deleted edoc associated with the specified entry. Returned the updated entry.
|
|
1431
1850
|
*/
|
|
1432
1851
|
deleteElectronicDocument(args: {
|
|
1433
1852
|
repositoryId: string;
|
|
@@ -1441,7 +1860,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1441
1860
|
* @param args.repositoryId The requested repository ID.
|
|
1442
1861
|
* @param args.entryId The requested document ID.
|
|
1443
1862
|
* @param args.pageRange (optional) The pages to be deleted.
|
|
1444
|
-
* @returns
|
|
1863
|
+
* @returns Successfully deleted pages associated with the specified entry. Returned the updated entry.
|
|
1445
1864
|
*/
|
|
1446
1865
|
deletePages(args: {
|
|
1447
1866
|
repositoryId: string;
|
|
@@ -1449,6 +1868,200 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1449
1868
|
pageRange?: string | null | undefined;
|
|
1450
1869
|
}): Promise<Entry>;
|
|
1451
1870
|
protected processDeletePages(response: Response): Promise<Entry>;
|
|
1871
|
+
/**
|
|
1872
|
+
* - Creates one or more new pages in the specified document.
|
|
1873
|
+
- Optional imageFiles form field: up to 10 image files, 100 MB aggregate.
|
|
1874
|
+
- Optional textPages array in the request JSON part. Aggregate size must be below 100 MB.
|
|
1875
|
+
- The two arrays are paired by index: page[i] gets imageFiles[i] and textPages[i].
|
|
1876
|
+
- The number of pages created is max(imageFiles.Count, textPages.Count). If one array is shorter, pages beyond its length are created without that part.
|
|
1877
|
+
- If neither imageFiles nor textPages is provided, one empty page is created.
|
|
1878
|
+
- If pageNumber is omitted, pages are appended to the end. If provided, pages are inserted at that 1-based position; existing pages shift down.
|
|
1879
|
+
- generateText triggers OCR when imageFiles are provided. When generateText is true and imageFiles are present, textPages is ignored because OCR-generated text would overwrite any provided text.
|
|
1880
|
+
- Required OAuth scope: repository.Write
|
|
1881
|
+
* @param args.repositoryId The requested repository ID.
|
|
1882
|
+
* @param args.entryId The requested document ID.
|
|
1883
|
+
* @param args.pageNumber (optional) Optional 1-based page number. If omitted, pages are appended to the end. If provided, pages are inserted at that position.
|
|
1884
|
+
* @param args.generateText (optional) If true, triggers server-side text generation (OCR) for image pages. Default is false.
|
|
1885
|
+
* @param args.request (optional)
|
|
1886
|
+
* @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. On UpdateDocument, existing pages are preserved by default and deleted first when overwriteContent=true. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
|
|
1887
|
+
* @returns Successfully created pages in the specified document. Returned the updated entry.
|
|
1888
|
+
*/
|
|
1889
|
+
createPages(args: {
|
|
1890
|
+
repositoryId: string;
|
|
1891
|
+
entryId: number;
|
|
1892
|
+
pageNumber?: number | null | undefined;
|
|
1893
|
+
generateText?: boolean | undefined;
|
|
1894
|
+
request?: PagesContentRequest | undefined;
|
|
1895
|
+
imageFiles?: FileParameter[] | undefined;
|
|
1896
|
+
}): Promise<Entry>;
|
|
1897
|
+
protected processCreatePages(response: Response): Promise<Entry>;
|
|
1898
|
+
/**
|
|
1899
|
+
* - Deletes all existing pages on the document, then creates new pages from the provided content. This is a single operation — one lock scope, one auto-version if the document is under version control.
|
|
1900
|
+
- At least one `imageFile` or `textPage` must be provided. To delete all pages without replacement, use DELETE /Pages.
|
|
1901
|
+
- The `imageFiles` and `textPages` arrays are paired by index (same rules as POST /Pages).
|
|
1902
|
+
- Required OAuth scope: repository.Write
|
|
1903
|
+
* @param args.repositoryId The requested repository ID.
|
|
1904
|
+
* @param args.entryId The requested document ID.
|
|
1905
|
+
* @param args.generateText (optional) If true, triggers server-side text generation (OCR) after creating pages. Default is false.
|
|
1906
|
+
* @param args.request (optional)
|
|
1907
|
+
* @param args.imageFiles (optional) Optional. Up to 10 image files (100 MB aggregate) that are appended as image pages. On UpdateDocument, existing pages are preserved by default and deleted first when overwriteContent=true. Set generateImagePagesText=false in the request body to skip OCR for these pages (default: true).
|
|
1908
|
+
* @returns Successfully replaced all pages in the specified document. Returned the updated entry.
|
|
1909
|
+
*/
|
|
1910
|
+
replacePages(args: {
|
|
1911
|
+
repositoryId: string;
|
|
1912
|
+
entryId: number;
|
|
1913
|
+
generateText?: boolean | undefined;
|
|
1914
|
+
request?: PagesContentRequest | undefined;
|
|
1915
|
+
imageFiles?: FileParameter[] | undefined;
|
|
1916
|
+
}): Promise<Entry>;
|
|
1917
|
+
protected processReplacePages(response: Response): Promise<Entry>;
|
|
1918
|
+
/**
|
|
1919
|
+
* - Returns a list of page properties including image dimensions, rotation angle, and content flags.
|
|
1920
|
+
- Pages are returned in ascending pageNumber order; that order is fixed and not configurable.
|
|
1921
|
+
- Default page size: 150. Allowed OData query options: Select | Count | SkipToken | Top | Prefer.
|
|
1922
|
+
- pageRange filters which pages are returned before paging is applied. Combine pageRange with $top/$skiptoken to paginate within a known range.
|
|
1923
|
+
- Required OAuth scope: repository.Read
|
|
1924
|
+
* @param args.repositoryId The requested repository ID.
|
|
1925
|
+
* @param args.entryId The requested document ID.
|
|
1926
|
+
* @param args.pageRange (optional) Optional comma-separated page numbers and ranges (e.g., "1,3-5,8-10"). Ranges must not overlap. When omitted, all pages are returned (subject to paging).
|
|
1927
|
+
* @param args.prefer (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
1928
|
+
* @param args.select (optional) Limits the properties returned in the result.
|
|
1929
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
1930
|
+
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
1931
|
+
* @returns Successfully retrieved a paged listing of page information for the document.
|
|
1932
|
+
*/
|
|
1933
|
+
listPageInfos(args: {
|
|
1934
|
+
repositoryId: string;
|
|
1935
|
+
entryId: number;
|
|
1936
|
+
pageRange?: string | null | undefined;
|
|
1937
|
+
prefer?: string | null | undefined;
|
|
1938
|
+
select?: string | null | undefined;
|
|
1939
|
+
top?: number | undefined;
|
|
1940
|
+
count?: boolean | undefined;
|
|
1941
|
+
}): Promise<PageInfoCollectionResponse>;
|
|
1942
|
+
protected processListPageInfos(response: Response): Promise<PageInfoCollectionResponse>;
|
|
1943
|
+
/**
|
|
1944
|
+
* - Overwrites the image and/or text part of the specified page. At least one of `imageFile` or `request` (with text) must be provided.
|
|
1945
|
+
- Parts not provided are left unchanged — e.g. providing only `imageFile` replaces the image without affecting existing text.
|
|
1946
|
+
- pageNumber is 1-based.
|
|
1947
|
+
- Required OAuth scope: repository.Write
|
|
1948
|
+
* @param args.repositoryId The requested repository ID.
|
|
1949
|
+
* @param args.entryId The requested document ID.
|
|
1950
|
+
* @param args.pageNumber The 1-based page number.
|
|
1951
|
+
* @param args.generateText (optional) If true, triggers server-side text generation (OCR) after writing. Default is false.
|
|
1952
|
+
* @param args.imageFile (optional) Optional. The image file to upload to replace the page's image content. See https://doc.laserfiche.com/ for supported image file formats. At least one of imageFile or request (with text) must be provided.
|
|
1953
|
+
* @param args.request (optional)
|
|
1954
|
+
* @returns Successfully wrote the image content of the specified page. Returned the updated entry.
|
|
1955
|
+
*/
|
|
1956
|
+
writePage(args: {
|
|
1957
|
+
repositoryId: string;
|
|
1958
|
+
entryId: number;
|
|
1959
|
+
pageNumber: number;
|
|
1960
|
+
generateText?: boolean | undefined;
|
|
1961
|
+
imageFile?: FileParameter | undefined;
|
|
1962
|
+
request?: WritePageTextRequest | undefined;
|
|
1963
|
+
}): Promise<Entry>;
|
|
1964
|
+
protected processWritePage(response: Response): Promise<Entry>;
|
|
1965
|
+
/**
|
|
1966
|
+
* - Moves the specified pages within the same document to a new position.
|
|
1967
|
+
- pageRange: A comma-separated string of non-overlapping single values or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12."
|
|
1968
|
+
- destinationPageNumber: The 1-based page number where the pages will be moved before.
|
|
1969
|
+
- Required OAuth scope: repository.Write
|
|
1970
|
+
* @param args.repositoryId The requested repository ID.
|
|
1971
|
+
* @param args.entryId The requested document ID.
|
|
1972
|
+
* @param args.request The request body containing the page range and destination.
|
|
1973
|
+
* @returns Successfully moved pages within the specified document. Returned the updated entry.
|
|
1974
|
+
*/
|
|
1975
|
+
movePages(args: {
|
|
1976
|
+
repositoryId: string;
|
|
1977
|
+
entryId: number;
|
|
1978
|
+
request: MovePagesRequest;
|
|
1979
|
+
}): Promise<Entry>;
|
|
1980
|
+
protected processMovePages(response: Response): Promise<Entry>;
|
|
1981
|
+
/**
|
|
1982
|
+
* - Copies the specified pages from the source document to the destination document.
|
|
1983
|
+
- The source document retains its pages; copies are inserted into the destination.
|
|
1984
|
+
- pageRange: A comma-separated string of non-overlapping single values or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12." The total number of distinct pages cannot exceed 500.
|
|
1985
|
+
- destinationEntryId: The entry ID of the destination document.
|
|
1986
|
+
- destinationPageNumber: The 1-based page number in the destination document where pages will be inserted before.
|
|
1987
|
+
- Required OAuth scope: repository.Write
|
|
1988
|
+
* @param args.repositoryId The requested repository ID.
|
|
1989
|
+
* @param args.entryId The source document ID.
|
|
1990
|
+
* @param args.request The request body containing the page range, destination entry ID, and destination page number.
|
|
1991
|
+
* @returns Successfully copied pages from the source document to the destination document. The source document retains its pages. Returned the updated source entry.
|
|
1992
|
+
*/
|
|
1993
|
+
copyPages(args: {
|
|
1994
|
+
repositoryId: string;
|
|
1995
|
+
entryId: number;
|
|
1996
|
+
request: CopyPagesRequest;
|
|
1997
|
+
}): Promise<Entry>;
|
|
1998
|
+
protected processCopyPages(response: Response): Promise<Entry>;
|
|
1999
|
+
/**
|
|
2000
|
+
* - Rotates the image of the specified page by the given angle.
|
|
2001
|
+
- rotationAngle: The rotation angle in degrees. Accepted values: 0, 90, 180, 270.
|
|
2002
|
+
- pageNumber is 1-based.
|
|
2003
|
+
- Required OAuth scope: repository.Write
|
|
2004
|
+
* @param args.repositoryId The requested repository ID.
|
|
2005
|
+
* @param args.entryId The requested document ID.
|
|
2006
|
+
* @param args.pageNumber The 1-based page number of the page to rotate.
|
|
2007
|
+
* @param args.request The request body containing the rotation angle.
|
|
2008
|
+
* @returns Successfully rotated the image page. Returned the updated entry.
|
|
2009
|
+
*/
|
|
2010
|
+
rotateImagePage(args: {
|
|
2011
|
+
repositoryId: string;
|
|
2012
|
+
entryId: number;
|
|
2013
|
+
pageNumber: number;
|
|
2014
|
+
request: RotateImagePageRequest;
|
|
2015
|
+
}): Promise<Entry>;
|
|
2016
|
+
protected processRotateImagePage(response: Response): Promise<Entry>;
|
|
2017
|
+
/**
|
|
2018
|
+
* - Returns the raw image data for the specified page as a binary stream.
|
|
2019
|
+
- pageNumber is 1-based.
|
|
2020
|
+
- Required OAuth scope: repository.Read
|
|
2021
|
+
* @param args.repositoryId The requested repository ID.
|
|
2022
|
+
* @param args.entryId The requested document ID.
|
|
2023
|
+
* @param args.pageNumber The 1-based page number of the page to retrieve the image for.
|
|
2024
|
+
* @param args.select (optional) Limits the properties returned in the result.
|
|
2025
|
+
* @returns Successfully retrieved the image content for the specified page.
|
|
2026
|
+
*/
|
|
2027
|
+
getPageImage(args: {
|
|
2028
|
+
repositoryId: string;
|
|
2029
|
+
entryId: number;
|
|
2030
|
+
pageNumber: number;
|
|
2031
|
+
select?: string | null | undefined;
|
|
2032
|
+
}): Promise<FileResponse>;
|
|
2033
|
+
protected processGetPageImage(response: Response): Promise<FileResponse>;
|
|
2034
|
+
/**
|
|
2035
|
+
* - Returns the text content for the specified page.
|
|
2036
|
+
- pageNumber is 1-based.
|
|
2037
|
+
- Required OAuth scope: repository.Read
|
|
2038
|
+
* @param args.repositoryId The requested repository ID.
|
|
2039
|
+
* @param args.entryId The requested document ID.
|
|
2040
|
+
* @param args.pageNumber The 1-based page number of the page to retrieve the text for.
|
|
2041
|
+
* @param args.select (optional) Limits the properties returned in the result.
|
|
2042
|
+
* @returns Successfully retrieved the text content for the specified page.
|
|
2043
|
+
*/
|
|
2044
|
+
getPageText(args: {
|
|
2045
|
+
repositoryId: string;
|
|
2046
|
+
entryId: number;
|
|
2047
|
+
pageNumber: number;
|
|
2048
|
+
select?: string | null | undefined;
|
|
2049
|
+
}): Promise<PageTextResponse>;
|
|
2050
|
+
protected processGetPageText(response: Response): Promise<PageTextResponse>;
|
|
2051
|
+
/**
|
|
2052
|
+
* - Triggers server-side text generation for the specified document.
|
|
2053
|
+
- For documents with image pages, this performs OCR to generate searchable text.
|
|
2054
|
+
- For documents with an electronic document part (e.g., PDF), this extracts embedded text.
|
|
2055
|
+
- Required OAuth scope: repository.Write
|
|
2056
|
+
* @param args.repositoryId The requested repository ID.
|
|
2057
|
+
* @param args.entryId The requested document ID.
|
|
2058
|
+
* @returns Successfully triggered text generation for the document. Returned the updated entry.
|
|
2059
|
+
*/
|
|
2060
|
+
generateText(args: {
|
|
2061
|
+
repositoryId: string;
|
|
2062
|
+
entryId: number;
|
|
2063
|
+
}): Promise<Entry>;
|
|
2064
|
+
protected processGenerateText(response: Response): Promise<Entry>;
|
|
1452
2065
|
/**
|
|
1453
2066
|
* - Returns dynamic field logic values with the current values of the fields in the template.
|
|
1454
2067
|
- Provide an entry ID and field values in the JSON body to get dynamic field logic values.
|
|
@@ -1457,7 +2070,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1457
2070
|
* @param args.repositoryId The requested repository ID.
|
|
1458
2071
|
* @param args.entryId The requested entry ID.
|
|
1459
2072
|
* @param args.request The request body.
|
|
1460
|
-
* @returns
|
|
2073
|
+
* @returns Successfully returned dynamic field values for specified entry, template, and field values.
|
|
1461
2074
|
*/
|
|
1462
2075
|
listDynamicFieldValues(args: {
|
|
1463
2076
|
repositoryId: string;
|
|
@@ -1476,7 +2089,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1476
2089
|
- Required OAuth scope: repository.Write
|
|
1477
2090
|
* @param args.repositoryId The requested repository ID.
|
|
1478
2091
|
* @param args.entryId The ID of the entry that will have its template removed.
|
|
1479
|
-
* @returns
|
|
2092
|
+
* @returns Successfully removed the currently assigned template from requested entry. Returned updated entry.
|
|
1480
2093
|
*/
|
|
1481
2094
|
removeTemplate(args: {
|
|
1482
2095
|
repositoryId: string;
|
|
@@ -1492,7 +2105,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1492
2105
|
* @param args.entryId The ID of entry that will have its template updated.
|
|
1493
2106
|
* @param args.request The template and template fields that will be assigned to the entry.
|
|
1494
2107
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens.
|
|
1495
|
-
* @returns
|
|
2108
|
+
* @returns Successfully assigned specified template to requested entry. Returned updated entry.
|
|
1496
2109
|
*/
|
|
1497
2110
|
setTemplate(args: {
|
|
1498
2111
|
repositoryId: string;
|
|
@@ -1501,12 +2114,118 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
1501
2114
|
culture?: string | null | undefined;
|
|
1502
2115
|
}): Promise<Entry>;
|
|
1503
2116
|
protected processSetTemplate(response: Response): Promise<Entry>;
|
|
2117
|
+
/**
|
|
2118
|
+
* - Creates a persistent lock on the specified document. Persistent locks survive session disconnect and server restart.
|
|
2119
|
+
- Optionally specify a comment and lock extent (Page, Edoc, Metadata, or All). Defaults to All.
|
|
2120
|
+
- Returns lock info including the lock token, owner, and extent.
|
|
2121
|
+
- Required OAuth scope: repository.Write
|
|
2122
|
+
* @param args.repositoryId The requested repository ID.
|
|
2123
|
+
* @param args.entryId The requested document ID.
|
|
2124
|
+
* @param args.request (optional) The request body containing optional lock comment and extent.
|
|
2125
|
+
* @returns Successfully created a persistent lock on the document.
|
|
2126
|
+
*/
|
|
2127
|
+
lockDocument(args: {
|
|
2128
|
+
repositoryId: string;
|
|
2129
|
+
entryId: number;
|
|
2130
|
+
request?: LockDocumentRequest | undefined;
|
|
2131
|
+
}): Promise<LockInfo>;
|
|
2132
|
+
protected processLockDocument(response: Response): Promise<LockInfo>;
|
|
2133
|
+
/**
|
|
2134
|
+
* - Returns the current persistent lock state of the document, including who holds the lock, the lock token, comment, extent, and creation timestamp.
|
|
2135
|
+
- If the document is not locked, returns lock info with isActive set to false.
|
|
2136
|
+
- Required OAuth scope: repository.Read
|
|
2137
|
+
* @param args.repositoryId The requested repository ID.
|
|
2138
|
+
* @param args.entryId The requested document ID.
|
|
2139
|
+
* @param args.select (optional) Limits the properties returned in the result.
|
|
2140
|
+
* @returns Successfully returned the lock state of the document.
|
|
2141
|
+
*/
|
|
2142
|
+
getDocumentLockInfo(args: {
|
|
2143
|
+
repositoryId: string;
|
|
2144
|
+
entryId: number;
|
|
2145
|
+
select?: string | null | undefined;
|
|
2146
|
+
}): Promise<LockInfo>;
|
|
2147
|
+
protected processGetDocumentLockInfo(response: Response): Promise<LockInfo>;
|
|
2148
|
+
/**
|
|
2149
|
+
* - Without a lockToken query parameter, removes the current user's persistent lock on the document.
|
|
2150
|
+
- With a lockToken query parameter, removes the specified lock regardless of owner (administrative unlock).
|
|
2151
|
+
- Required OAuth scope: repository.Write
|
|
2152
|
+
* @param args.repositoryId The requested repository ID.
|
|
2153
|
+
* @param args.entryId The requested document ID.
|
|
2154
|
+
* @param args.lockToken (optional) Optional lock token to unlock a specific lock held by another user (administrative unlock).
|
|
2155
|
+
* @returns Successfully removed the persistent lock from the document.
|
|
2156
|
+
*/
|
|
2157
|
+
unlockDocument(args: {
|
|
2158
|
+
repositoryId: string;
|
|
2159
|
+
entryId: number;
|
|
2160
|
+
lockToken?: string | null | undefined;
|
|
2161
|
+
}): Promise<void>;
|
|
2162
|
+
protected processUnlockDocument(response: Response): Promise<void>;
|
|
2163
|
+
/**
|
|
2164
|
+
* - Puts the specified document under version control. No-op if already under version control.
|
|
2165
|
+
- Documents must be under version control before they can be checked out.
|
|
2166
|
+
- Required OAuth scope: repository.Write
|
|
2167
|
+
* @param args.repositoryId The requested repository ID.
|
|
2168
|
+
* @param args.entryId The requested document ID.
|
|
2169
|
+
* @returns Successfully put the document under version control.
|
|
2170
|
+
*/
|
|
2171
|
+
putUnderVersionControl(args: {
|
|
2172
|
+
repositoryId: string;
|
|
2173
|
+
entryId: number;
|
|
2174
|
+
}): Promise<Entry>;
|
|
2175
|
+
protected processPutUnderVersionControl(response: Response): Promise<Entry>;
|
|
2176
|
+
/**
|
|
2177
|
+
* - Checks out the specified document for editing. The document must be under version control.
|
|
2178
|
+
- By default, a persistent lock is automatically acquired (lock=true). Set lock=false to check out without locking.
|
|
2179
|
+
- Optionally specify a comment for the check-out.
|
|
2180
|
+
- Returns an error if the document is not under version control.
|
|
2181
|
+
- Required OAuth scope: repository.Write
|
|
2182
|
+
* @param args.repositoryId The requested repository ID.
|
|
2183
|
+
* @param args.entryId The requested document ID.
|
|
2184
|
+
* @param args.request (optional) The request body containing optional lock and comment parameters.
|
|
2185
|
+
* @returns Successfully checked out the document.
|
|
2186
|
+
*/
|
|
2187
|
+
checkOutDocument(args: {
|
|
2188
|
+
repositoryId: string;
|
|
2189
|
+
entryId: number;
|
|
2190
|
+
request?: CheckOutDocumentRequest | undefined;
|
|
2191
|
+
}): Promise<Entry>;
|
|
2192
|
+
protected processCheckOutDocument(response: Response): Promise<Entry>;
|
|
2193
|
+
/**
|
|
2194
|
+
* - Checks in the specified document, creating a new version in the version history.
|
|
2195
|
+
- By default, releases the persistent lock if one is held. Set unlock to false to keep the lock.
|
|
2196
|
+
- Returns an error if the document is not currently checked out.
|
|
2197
|
+
- Required OAuth scope: repository.Write
|
|
2198
|
+
* @param args.repositoryId The requested repository ID.
|
|
2199
|
+
* @param args.entryId The requested document ID.
|
|
2200
|
+
* @param args.request (optional) Optional request body. If omitted, the persistent lock is released (default behavior).
|
|
2201
|
+
* @returns Successfully checked in the document. If a persistent lock was held and unlock was not set to false, the lock has been released.
|
|
2202
|
+
*/
|
|
2203
|
+
checkInDocument(args: {
|
|
2204
|
+
repositoryId: string;
|
|
2205
|
+
entryId: number;
|
|
2206
|
+
request?: CheckInDocumentRequest | undefined;
|
|
2207
|
+
}): Promise<Entry>;
|
|
2208
|
+
protected processCheckInDocument(response: Response): Promise<Entry>;
|
|
2209
|
+
/**
|
|
2210
|
+
* - Releases the check-out state without creating a new version in the version history.
|
|
2211
|
+
- Always releases the persistent lock if one is held.
|
|
2212
|
+
- Returns an error if the document is not under version control.
|
|
2213
|
+
- Required OAuth scope: repository.Write
|
|
2214
|
+
* @param args.repositoryId The requested repository ID.
|
|
2215
|
+
* @param args.entryId The requested document ID.
|
|
2216
|
+
* @returns Successfully undid the document check-out. Any persistent lock held on the document has been released.
|
|
2217
|
+
*/
|
|
2218
|
+
undoCheckOut(args: {
|
|
2219
|
+
repositoryId: string;
|
|
2220
|
+
entryId: number;
|
|
2221
|
+
}): Promise<Entry>;
|
|
2222
|
+
protected processUndoCheckOut(response: Response): Promise<Entry>;
|
|
1504
2223
|
}
|
|
1505
2224
|
export interface IRepositoriesClient {
|
|
1506
2225
|
/**
|
|
1507
2226
|
* - Returns the repository resource list that current user has access to.
|
|
1508
2227
|
- Required OAuth scope: repository.Read
|
|
1509
|
-
* @returns
|
|
2228
|
+
* @returns Successfully returned list of available repositories.
|
|
1510
2229
|
*/
|
|
1511
2230
|
listRepositories(args: {}): Promise<RepositoryCollectionResponse>;
|
|
1512
2231
|
}
|
|
@@ -1529,7 +2248,7 @@ export declare class RepositoriesClient implements IRepositoriesClient {
|
|
|
1529
2248
|
/**
|
|
1530
2249
|
* - Returns the repository resource list that current user has access to.
|
|
1531
2250
|
- Required OAuth scope: repository.Read
|
|
1532
|
-
* @returns
|
|
2251
|
+
* @returns Successfully returned list of available repositories.
|
|
1533
2252
|
*/
|
|
1534
2253
|
listRepositories(args: {}): Promise<RepositoryCollectionResponse>;
|
|
1535
2254
|
protected processListRepositories(response: Response): Promise<RepositoryCollectionResponse>;
|
|
@@ -1538,11 +2257,12 @@ export interface ISearchesClient {
|
|
|
1538
2257
|
/**
|
|
1539
2258
|
* - Runs a search operation on the repository.
|
|
1540
2259
|
- The status for search operations must be checked via the Tasks route.
|
|
2260
|
+
- For datetime search criteria that relate to time zone like CreateDate and ModifiedDate, the value should be in UTC time.
|
|
1541
2261
|
- Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage. FuzzyFactor: integer value that determines the degree to which a search will be considered a match (integer value for NumberOfLetters, or int value representing a percentage).
|
|
1542
2262
|
- Required OAuth scope: repository.Read
|
|
1543
2263
|
* @param args.repositoryId The requested repository ID.
|
|
1544
2264
|
* @param args.request The Laserfiche search command to run, optionally include fuzzy search settings.
|
|
1545
|
-
* @returns
|
|
2265
|
+
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
1546
2266
|
*/
|
|
1547
2267
|
startSearchEntry(args: {
|
|
1548
2268
|
repositoryId: string;
|
|
@@ -1555,6 +2275,7 @@ export interface ISearchesClient {
|
|
|
1555
2275
|
- Optional query parameter: refresh (default false). If the search listing should be refreshed to show updated values.
|
|
1556
2276
|
- Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.
|
|
1557
2277
|
- Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". sort order can be either "asc" or "desc".
|
|
2278
|
+
- When OData Select query option is used, 'entryType' is always included in the result.
|
|
1558
2279
|
- Required OAuth scope: repository.Read
|
|
1559
2280
|
* @param args.repositoryId The requested repository ID.
|
|
1560
2281
|
* @param args.taskId The requested task ID.
|
|
@@ -1566,10 +2287,10 @@ export interface ISearchesClient {
|
|
|
1566
2287
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.
|
|
1567
2288
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1568
2289
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
1569
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
2290
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
1570
2291
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
1571
2292
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
1572
|
-
* @returns
|
|
2293
|
+
* @returns Successfully returned search results.
|
|
1573
2294
|
*/
|
|
1574
2295
|
listSearchResults(args: {
|
|
1575
2296
|
repositoryId: string;
|
|
@@ -1597,10 +2318,10 @@ export interface ISearchesClient {
|
|
|
1597
2318
|
* @param args.prefer (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
1598
2319
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1599
2320
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
1600
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
2321
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
1601
2322
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
1602
2323
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
1603
|
-
* @returns
|
|
2324
|
+
* @returns Successfully returned context hits for specified search.
|
|
1604
2325
|
*/
|
|
1605
2326
|
listSearchContextHits(args: {
|
|
1606
2327
|
repositoryId: string;
|
|
@@ -1712,11 +2433,12 @@ export declare class SearchesClient implements ISearchesClient {
|
|
|
1712
2433
|
/**
|
|
1713
2434
|
* - Runs a search operation on the repository.
|
|
1714
2435
|
- The status for search operations must be checked via the Tasks route.
|
|
2436
|
+
- For datetime search criteria that relate to time zone like CreateDate and ModifiedDate, the value should be in UTC time.
|
|
1715
2437
|
- Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage. FuzzyFactor: integer value that determines the degree to which a search will be considered a match (integer value for NumberOfLetters, or int value representing a percentage).
|
|
1716
2438
|
- Required OAuth scope: repository.Read
|
|
1717
2439
|
* @param args.repositoryId The requested repository ID.
|
|
1718
2440
|
* @param args.request The Laserfiche search command to run, optionally include fuzzy search settings.
|
|
1719
|
-
* @returns
|
|
2441
|
+
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
1720
2442
|
*/
|
|
1721
2443
|
startSearchEntry(args: {
|
|
1722
2444
|
repositoryId: string;
|
|
@@ -1730,6 +2452,7 @@ export declare class SearchesClient implements ISearchesClient {
|
|
|
1730
2452
|
- Optional query parameter: refresh (default false). If the search listing should be refreshed to show updated values.
|
|
1731
2453
|
- Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.
|
|
1732
2454
|
- Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". sort order can be either "asc" or "desc".
|
|
2455
|
+
- When OData Select query option is used, 'entryType' is always included in the result.
|
|
1733
2456
|
- Required OAuth scope: repository.Read
|
|
1734
2457
|
* @param args.repositoryId The requested repository ID.
|
|
1735
2458
|
* @param args.taskId The requested task ID.
|
|
@@ -1741,10 +2464,10 @@ export declare class SearchesClient implements ISearchesClient {
|
|
|
1741
2464
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.
|
|
1742
2465
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1743
2466
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
1744
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
2467
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
1745
2468
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
1746
2469
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
1747
|
-
* @returns
|
|
2470
|
+
* @returns Successfully returned search results.
|
|
1748
2471
|
*/
|
|
1749
2472
|
listSearchResults(args: {
|
|
1750
2473
|
repositoryId: string;
|
|
@@ -1773,10 +2496,10 @@ export declare class SearchesClient implements ISearchesClient {
|
|
|
1773
2496
|
* @param args.prefer (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.
|
|
1774
2497
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1775
2498
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
1776
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
2499
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
1777
2500
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
1778
2501
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
1779
|
-
* @returns
|
|
2502
|
+
* @returns Successfully returned context hits for specified search.
|
|
1780
2503
|
*/
|
|
1781
2504
|
listSearchContextHits(args: {
|
|
1782
2505
|
repositoryId: string;
|
|
@@ -1796,7 +2519,9 @@ export interface ISimpleSearchesClient {
|
|
|
1796
2519
|
* - Runs a "simple" search operation on the repository.
|
|
1797
2520
|
- Returns a truncated search result listing.
|
|
1798
2521
|
- Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches.
|
|
2522
|
+
- For datetime search criteria that relate to time zone like CreateDate and ModifiedDate, the value should be in UTC time.
|
|
1799
2523
|
- Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.
|
|
2524
|
+
- When OData Select query option is used, 'entryType' is always included in the result.
|
|
1800
2525
|
- Required OAuth scope: repository.Read
|
|
1801
2526
|
* @param args.repositoryId The requested repository ID.
|
|
1802
2527
|
* @param args.request The Laserfiche search command to run.
|
|
@@ -1806,7 +2531,7 @@ export interface ISimpleSearchesClient {
|
|
|
1806
2531
|
* @param args.fields (optional) Optional array of field names. Field values corresponding to the given field names will be returned for each search result.
|
|
1807
2532
|
* @param args.formatFieldValues (optional) Indicates if field values should be formatted. Only applicable if Fields are specified. The default value is false.
|
|
1808
2533
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.
|
|
1809
|
-
* @returns
|
|
2534
|
+
* @returns Successfully returned search results.
|
|
1810
2535
|
*/
|
|
1811
2536
|
searchEntry(args: {
|
|
1812
2537
|
repositoryId: string;
|
|
@@ -1830,7 +2555,9 @@ export declare class SimpleSearchesClient implements ISimpleSearchesClient {
|
|
|
1830
2555
|
* - Runs a "simple" search operation on the repository.
|
|
1831
2556
|
- Returns a truncated search result listing.
|
|
1832
2557
|
- Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches.
|
|
2558
|
+
- For datetime search criteria that relate to time zone like CreateDate and ModifiedDate, the value should be in UTC time.
|
|
1833
2559
|
- Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.
|
|
2560
|
+
- When OData Select query option is used, 'entryType' is always included in the result.
|
|
1834
2561
|
- Required OAuth scope: repository.Read
|
|
1835
2562
|
* @param args.repositoryId The requested repository ID.
|
|
1836
2563
|
* @param args.request The Laserfiche search command to run.
|
|
@@ -1840,7 +2567,7 @@ export declare class SimpleSearchesClient implements ISimpleSearchesClient {
|
|
|
1840
2567
|
* @param args.fields (optional) Optional array of field names. Field values corresponding to the given field names will be returned for each search result.
|
|
1841
2568
|
* @param args.formatFieldValues (optional) Indicates if field values should be formatted. Only applicable if Fields are specified. The default value is false.
|
|
1842
2569
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFieldValues query parameter must be set to true, otherwise culture will not be used for formatting.
|
|
1843
|
-
* @returns
|
|
2570
|
+
* @returns Successfully returned search results.
|
|
1844
2571
|
*/
|
|
1845
2572
|
searchEntry(args: {
|
|
1846
2573
|
repositoryId: string;
|
|
@@ -1865,10 +2592,10 @@ export interface ITagDefinitionsClient {
|
|
|
1865
2592
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
1866
2593
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1867
2594
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
1868
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
2595
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
1869
2596
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
1870
2597
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
1871
|
-
* @returns
|
|
2598
|
+
* @returns Successfully returned list of tag definitions.
|
|
1872
2599
|
*/
|
|
1873
2600
|
listTagDefinitions(args: {
|
|
1874
2601
|
repositoryId: string;
|
|
@@ -1889,7 +2616,7 @@ export interface ITagDefinitionsClient {
|
|
|
1889
2616
|
* @param args.tagId The requested tag definition ID.
|
|
1890
2617
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
1891
2618
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1892
|
-
* @returns
|
|
2619
|
+
* @returns Successfully returned requested tag definition.
|
|
1893
2620
|
*/
|
|
1894
2621
|
getTagDefinition(args: {
|
|
1895
2622
|
repositoryId: string;
|
|
@@ -1954,10 +2681,10 @@ export declare class TagDefinitionsClient implements ITagDefinitionsClient {
|
|
|
1954
2681
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
1955
2682
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1956
2683
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
1957
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
2684
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
1958
2685
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
1959
2686
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
1960
|
-
* @returns
|
|
2687
|
+
* @returns Successfully returned list of tag definitions.
|
|
1961
2688
|
*/
|
|
1962
2689
|
listTagDefinitions(args: {
|
|
1963
2690
|
repositoryId: string;
|
|
@@ -1979,7 +2706,7 @@ export declare class TagDefinitionsClient implements ITagDefinitionsClient {
|
|
|
1979
2706
|
* @param args.tagId The requested tag definition ID.
|
|
1980
2707
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
1981
2708
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
1982
|
-
* @returns
|
|
2709
|
+
* @returns Successfully returned requested tag definition.
|
|
1983
2710
|
*/
|
|
1984
2711
|
getTagDefinition(args: {
|
|
1985
2712
|
repositoryId: string;
|
|
@@ -1999,7 +2726,7 @@ export interface ITasksClient {
|
|
|
1999
2726
|
- Required OAuth scope: None
|
|
2000
2727
|
* @param args.repositoryId The requested repository ID
|
|
2001
2728
|
* @param args.taskIds (optional) An array of task IDs. Leave this parameter empty to get the list of all the tasks associated with the current access token.
|
|
2002
|
-
* @returns
|
|
2729
|
+
* @returns Returned a list of tasks.
|
|
2003
2730
|
*/
|
|
2004
2731
|
listTasks(args: {
|
|
2005
2732
|
repositoryId: string;
|
|
@@ -2014,12 +2741,26 @@ export interface ITasksClient {
|
|
|
2014
2741
|
- Required OAuth scope: None
|
|
2015
2742
|
* @param args.repositoryId The requested repository ID
|
|
2016
2743
|
* @param args.taskIds (optional) An array of task IDs. Leave this parameter empty to cancel the list of all the tasks associated with the current access token.
|
|
2017
|
-
* @returns
|
|
2744
|
+
* @returns Successfully canceled requested tasks. Returned successfully canceled tasks.
|
|
2018
2745
|
*/
|
|
2019
2746
|
cancelTasks(args: {
|
|
2020
2747
|
repositoryId: string;
|
|
2021
2748
|
taskIds?: string[] | null | undefined;
|
|
2022
2749
|
}): Promise<CancelTasksResponse>;
|
|
2750
|
+
/**
|
|
2751
|
+
* Starts a test operation that behaves according to specified parameters.
|
|
2752
|
+
* @param args.repositoryId The requested repository id.
|
|
2753
|
+
* @param args.operationTime (optional) The time the operation will take to complete.
|
|
2754
|
+
* @param args.hasRedirectUri (optional) If operation adds redirect uri.
|
|
2755
|
+
* @param args.hasError (optional) If mock operation should return "failed" status.
|
|
2756
|
+
* @returns Test task was started successfully.
|
|
2757
|
+
*/
|
|
2758
|
+
startTestTask(args: {
|
|
2759
|
+
repositoryId: string;
|
|
2760
|
+
operationTime?: number | undefined;
|
|
2761
|
+
hasRedirectUri?: boolean | undefined;
|
|
2762
|
+
hasError?: boolean | undefined;
|
|
2763
|
+
}): Promise<StartTaskResponse>;
|
|
2023
2764
|
}
|
|
2024
2765
|
export declare class TasksClient implements ITasksClient {
|
|
2025
2766
|
private http;
|
|
@@ -2037,7 +2778,7 @@ export declare class TasksClient implements ITasksClient {
|
|
|
2037
2778
|
- Required OAuth scope: None
|
|
2038
2779
|
* @param args.repositoryId The requested repository ID
|
|
2039
2780
|
* @param args.taskIds (optional) An array of task IDs. Leave this parameter empty to get the list of all the tasks associated with the current access token.
|
|
2040
|
-
* @returns
|
|
2781
|
+
* @returns Returned a list of tasks.
|
|
2041
2782
|
*/
|
|
2042
2783
|
listTasks(args: {
|
|
2043
2784
|
repositoryId: string;
|
|
@@ -2053,13 +2794,28 @@ export declare class TasksClient implements ITasksClient {
|
|
|
2053
2794
|
- Required OAuth scope: None
|
|
2054
2795
|
* @param args.repositoryId The requested repository ID
|
|
2055
2796
|
* @param args.taskIds (optional) An array of task IDs. Leave this parameter empty to cancel the list of all the tasks associated with the current access token.
|
|
2056
|
-
* @returns
|
|
2797
|
+
* @returns Successfully canceled requested tasks. Returned successfully canceled tasks.
|
|
2057
2798
|
*/
|
|
2058
2799
|
cancelTasks(args: {
|
|
2059
2800
|
repositoryId: string;
|
|
2060
2801
|
taskIds?: string[] | null | undefined;
|
|
2061
2802
|
}): Promise<CancelTasksResponse>;
|
|
2062
2803
|
protected processCancelTasks(response: Response): Promise<CancelTasksResponse>;
|
|
2804
|
+
/**
|
|
2805
|
+
* Starts a test operation that behaves according to specified parameters.
|
|
2806
|
+
* @param args.repositoryId The requested repository id.
|
|
2807
|
+
* @param args.operationTime (optional) The time the operation will take to complete.
|
|
2808
|
+
* @param args.hasRedirectUri (optional) If operation adds redirect uri.
|
|
2809
|
+
* @param args.hasError (optional) If mock operation should return "failed" status.
|
|
2810
|
+
* @returns Test task was started successfully.
|
|
2811
|
+
*/
|
|
2812
|
+
startTestTask(args: {
|
|
2813
|
+
repositoryId: string;
|
|
2814
|
+
operationTime?: number | undefined;
|
|
2815
|
+
hasRedirectUri?: boolean | undefined;
|
|
2816
|
+
hasError?: boolean | undefined;
|
|
2817
|
+
}): Promise<StartTaskResponse>;
|
|
2818
|
+
protected processStartTestTask(response: Response): Promise<StartTaskResponse>;
|
|
2063
2819
|
}
|
|
2064
2820
|
export interface ITemplateDefinitionsClient {
|
|
2065
2821
|
/**
|
|
@@ -2073,10 +2829,10 @@ export interface ITemplateDefinitionsClient {
|
|
|
2073
2829
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
2074
2830
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
2075
2831
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
2076
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
2832
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
2077
2833
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
2078
2834
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
2079
|
-
* @returns
|
|
2835
|
+
* @returns Returned list of template definitions.
|
|
2080
2836
|
*/
|
|
2081
2837
|
listTemplateDefinitions(args: {
|
|
2082
2838
|
repositoryId: string;
|
|
@@ -2098,7 +2854,7 @@ export interface ITemplateDefinitionsClient {
|
|
|
2098
2854
|
* @param args.templateId The requested template definition ID.
|
|
2099
2855
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
2100
2856
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
2101
|
-
* @returns
|
|
2857
|
+
* @returns Successfully found and returned specified template.
|
|
2102
2858
|
*/
|
|
2103
2859
|
getTemplateDefinition(args: {
|
|
2104
2860
|
repositoryId: string;
|
|
@@ -2117,10 +2873,10 @@ export interface ITemplateDefinitionsClient {
|
|
|
2117
2873
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
2118
2874
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
2119
2875
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
2120
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
2876
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
2121
2877
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
2122
2878
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
2123
|
-
* @returns
|
|
2879
|
+
* @returns Returned list of field definitions for specified template.
|
|
2124
2880
|
*/
|
|
2125
2881
|
listTemplateFieldDefinitionsByTemplateId(args: {
|
|
2126
2882
|
repositoryId: string;
|
|
@@ -2144,10 +2900,10 @@ export interface ITemplateDefinitionsClient {
|
|
|
2144
2900
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
2145
2901
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
2146
2902
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
2147
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
2903
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
2148
2904
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
2149
2905
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
2150
|
-
* @returns
|
|
2906
|
+
* @returns Returned list of field definitions for specified template.
|
|
2151
2907
|
*/
|
|
2152
2908
|
listTemplateFieldDefinitionsByTemplateName(args: {
|
|
2153
2909
|
repositoryId: string;
|
|
@@ -2302,10 +3058,10 @@ export declare class TemplateDefinitionsClient implements ITemplateDefinitionsCl
|
|
|
2302
3058
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
2303
3059
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
2304
3060
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
2305
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
3061
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
2306
3062
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
2307
3063
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
2308
|
-
* @returns
|
|
3064
|
+
* @returns Returned list of template definitions.
|
|
2309
3065
|
*/
|
|
2310
3066
|
listTemplateDefinitions(args: {
|
|
2311
3067
|
repositoryId: string;
|
|
@@ -2328,7 +3084,7 @@ export declare class TemplateDefinitionsClient implements ITemplateDefinitionsCl
|
|
|
2328
3084
|
* @param args.templateId The requested template definition ID.
|
|
2329
3085
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
2330
3086
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
2331
|
-
* @returns
|
|
3087
|
+
* @returns Successfully found and returned specified template.
|
|
2332
3088
|
*/
|
|
2333
3089
|
getTemplateDefinition(args: {
|
|
2334
3090
|
repositoryId: string;
|
|
@@ -2348,10 +3104,10 @@ export declare class TemplateDefinitionsClient implements ITemplateDefinitionsCl
|
|
|
2348
3104
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
2349
3105
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
2350
3106
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
2351
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
3107
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
2352
3108
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
2353
3109
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
2354
|
-
* @returns
|
|
3110
|
+
* @returns Returned list of field definitions for specified template.
|
|
2355
3111
|
*/
|
|
2356
3112
|
listTemplateFieldDefinitionsByTemplateId(args: {
|
|
2357
3113
|
repositoryId: string;
|
|
@@ -2376,10 +3132,10 @@ export declare class TemplateDefinitionsClient implements ITemplateDefinitionsCl
|
|
|
2376
3132
|
* @param args.culture (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.
|
|
2377
3133
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
2378
3134
|
* @param args.orderby (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.
|
|
2379
|
-
* @param args.top (optional) Limits the number of items returned from a collection.
|
|
3135
|
+
* @param args.top (optional) Limits the number of items returned from a collection. The maximum value is 150.
|
|
2380
3136
|
* @param args.skip (optional) Excludes the specified number of items of the queried collection from the result.
|
|
2381
3137
|
* @param args.count (optional) Indicates whether the total count of items within a collection are returned in the result.
|
|
2382
|
-
* @returns
|
|
3138
|
+
* @returns Returned list of field definitions for specified template.
|
|
2383
3139
|
*/
|
|
2384
3140
|
listTemplateFieldDefinitionsByTemplateName(args: {
|
|
2385
3141
|
repositoryId: string;
|
|
@@ -2400,7 +3156,8 @@ export declare class AttributeCollectionResponse implements IAttributeCollection
|
|
|
2400
3156
|
odataNextLink?: string | undefined;
|
|
2401
3157
|
/** The total count of items within a collection. */
|
|
2402
3158
|
odataCount?: number | undefined;
|
|
2403
|
-
value
|
|
3159
|
+
/** Gets or sets the OData response content in the "value". */
|
|
3160
|
+
value?: Attribute[] | undefined;
|
|
2404
3161
|
constructor(data?: IAttributeCollectionResponse);
|
|
2405
3162
|
init(_data?: any): void;
|
|
2406
3163
|
static fromJS(data: any): AttributeCollectionResponse;
|
|
@@ -2412,7 +3169,8 @@ export interface IAttributeCollectionResponse {
|
|
|
2412
3169
|
odataNextLink?: string | undefined;
|
|
2413
3170
|
/** The total count of items within a collection. */
|
|
2414
3171
|
odataCount?: number | undefined;
|
|
2415
|
-
value
|
|
3172
|
+
/** Gets or sets the OData response content in the "value". */
|
|
3173
|
+
value?: Attribute[] | undefined;
|
|
2416
3174
|
}
|
|
2417
3175
|
/** Represents a trustee attribute. */
|
|
2418
3176
|
export declare class Attribute implements IAttribute {
|
|
@@ -2432,7 +3190,7 @@ export interface IAttribute {
|
|
|
2432
3190
|
/** The attribute value. */
|
|
2433
3191
|
value?: string | undefined;
|
|
2434
3192
|
}
|
|
2435
|
-
/** A machine-readable format for specifying errors in HTTP API responses
|
|
3193
|
+
/** A machine-readable format for specifying errors in HTTP API responses, per RFC 9457 (https://www.rfc-editor.org/rfc/rfc9457). Supersedes RFC 7807. */
|
|
2436
3194
|
export declare class ProblemDetails implements IProblemDetails {
|
|
2437
3195
|
/** The problem type. */
|
|
2438
3196
|
type?: string | undefined;
|
|
@@ -2461,7 +3219,7 @@ export declare class ProblemDetails implements IProblemDetails {
|
|
|
2461
3219
|
static fromJS(data: any): ProblemDetails;
|
|
2462
3220
|
toJSON(data?: any): any;
|
|
2463
3221
|
}
|
|
2464
|
-
/** A machine-readable format for specifying errors in HTTP API responses
|
|
3222
|
+
/** A machine-readable format for specifying errors in HTTP API responses, per RFC 9457 (https://www.rfc-editor.org/rfc/rfc9457). Supersedes RFC 7807. */
|
|
2465
3223
|
export interface IProblemDetails {
|
|
2466
3224
|
/** The problem type. */
|
|
2467
3225
|
type?: string | undefined;
|
|
@@ -2491,7 +3249,8 @@ export declare class AuditReasonCollectionResponse implements IAuditReasonCollec
|
|
|
2491
3249
|
odataNextLink?: string | undefined;
|
|
2492
3250
|
/** The total count of items within a collection. */
|
|
2493
3251
|
odataCount?: number | undefined;
|
|
2494
|
-
value
|
|
3252
|
+
/** Gets or sets the OData response content in the "value". */
|
|
3253
|
+
value?: AuditReason[] | undefined;
|
|
2495
3254
|
constructor(data?: IAuditReasonCollectionResponse);
|
|
2496
3255
|
init(_data?: any): void;
|
|
2497
3256
|
static fromJS(data: any): AuditReasonCollectionResponse;
|
|
@@ -2503,7 +3262,8 @@ export interface IAuditReasonCollectionResponse {
|
|
|
2503
3262
|
odataNextLink?: string | undefined;
|
|
2504
3263
|
/** The total count of items within a collection. */
|
|
2505
3264
|
odataCount?: number | undefined;
|
|
2506
|
-
value
|
|
3265
|
+
/** Gets or sets the OData response content in the "value". */
|
|
3266
|
+
value?: AuditReason[] | undefined;
|
|
2507
3267
|
}
|
|
2508
3268
|
/** Represents a user-defined audit reason for an audit event. */
|
|
2509
3269
|
export declare class AuditReason implements IAuditReason {
|
|
@@ -2635,7 +3395,8 @@ export declare class FieldDefinitionCollectionResponse implements IFieldDefiniti
|
|
|
2635
3395
|
odataNextLink?: string | undefined;
|
|
2636
3396
|
/** The total count of items within a collection. */
|
|
2637
3397
|
odataCount?: number | undefined;
|
|
2638
|
-
value
|
|
3398
|
+
/** Gets or sets the OData response content in the "value". */
|
|
3399
|
+
value?: FieldDefinition[] | undefined;
|
|
2639
3400
|
constructor(data?: IFieldDefinitionCollectionResponse);
|
|
2640
3401
|
init(_data?: any): void;
|
|
2641
3402
|
static fromJS(data: any): FieldDefinitionCollectionResponse;
|
|
@@ -2647,7 +3408,8 @@ export interface IFieldDefinitionCollectionResponse {
|
|
|
2647
3408
|
odataNextLink?: string | undefined;
|
|
2648
3409
|
/** The total count of items within a collection. */
|
|
2649
3410
|
odataCount?: number | undefined;
|
|
2650
|
-
value
|
|
3411
|
+
/** Gets or sets the OData response content in the "value". */
|
|
3412
|
+
value?: FieldDefinition[] | undefined;
|
|
2651
3413
|
}
|
|
2652
3414
|
/** Response containing a collection of LinkDefinition. */
|
|
2653
3415
|
export declare class LinkDefinitionCollectionResponse implements ILinkDefinitionCollectionResponse {
|
|
@@ -2655,7 +3417,8 @@ export declare class LinkDefinitionCollectionResponse implements ILinkDefinition
|
|
|
2655
3417
|
odataNextLink?: string | undefined;
|
|
2656
3418
|
/** The total count of items within a collection. */
|
|
2657
3419
|
odataCount?: number | undefined;
|
|
2658
|
-
value
|
|
3420
|
+
/** Gets or sets the OData response content in the "value". */
|
|
3421
|
+
value?: LinkDefinition[] | undefined;
|
|
2659
3422
|
constructor(data?: ILinkDefinitionCollectionResponse);
|
|
2660
3423
|
init(_data?: any): void;
|
|
2661
3424
|
static fromJS(data: any): LinkDefinitionCollectionResponse;
|
|
@@ -2667,7 +3430,8 @@ export interface ILinkDefinitionCollectionResponse {
|
|
|
2667
3430
|
odataNextLink?: string | undefined;
|
|
2668
3431
|
/** The total count of items within a collection. */
|
|
2669
3432
|
odataCount?: number | undefined;
|
|
2670
|
-
value
|
|
3433
|
+
/** Gets or sets the OData response content in the "value". */
|
|
3434
|
+
value?: LinkDefinition[] | undefined;
|
|
2671
3435
|
}
|
|
2672
3436
|
/** Represents an entry link definition. */
|
|
2673
3437
|
export declare class LinkDefinition implements ILinkDefinition {
|
|
@@ -2721,10 +3485,13 @@ export declare class CreateMultipartUploadUrlsRequest implements ICreateMultipar
|
|
|
2721
3485
|
startingPartNumber?: number;
|
|
2722
3486
|
/** The value must be in the range [1, 100], meaning that in each call to the CreateMultipartUploadUrls api, a maximum of 100 Upload URLs can be requested. Further, each file chunk written to an Upload URL should be at least 5 MB. There is no minimum size limit for the last chunk. */
|
|
2723
3487
|
numberOfParts: number;
|
|
2724
|
-
/** The name of the file to be uploaded. The file extension in the name will be used as the
|
|
2725
|
-
|
|
2726
|
-
|
|
2727
|
-
|
|
3488
|
+
/** The name of the file to be uploaded. The file extension in the name will be used as the
|
|
3489
|
+
extension of the imported entry. Required when startingPartNumber is 1 (first batch);
|
|
3490
|
+
ignored on subsequent batches. */
|
|
3491
|
+
fileName: string;
|
|
3492
|
+
/** The mime-type of the file to be uploaded. Required when startingPartNumber is 1
|
|
3493
|
+
(first batch); ignored on subsequent batches. */
|
|
3494
|
+
mimeType: string;
|
|
2728
3495
|
constructor(data?: ICreateMultipartUploadUrlsRequest);
|
|
2729
3496
|
init(_data?: any): void;
|
|
2730
3497
|
static fromJS(data: any): CreateMultipartUploadUrlsRequest;
|
|
@@ -2738,10 +3505,13 @@ export interface ICreateMultipartUploadUrlsRequest {
|
|
|
2738
3505
|
startingPartNumber?: number;
|
|
2739
3506
|
/** The value must be in the range [1, 100], meaning that in each call to the CreateMultipartUploadUrls api, a maximum of 100 Upload URLs can be requested. Further, each file chunk written to an Upload URL should be at least 5 MB. There is no minimum size limit for the last chunk. */
|
|
2740
3507
|
numberOfParts: number;
|
|
2741
|
-
/** The name of the file to be uploaded. The file extension in the name will be used as the
|
|
2742
|
-
|
|
2743
|
-
|
|
2744
|
-
|
|
3508
|
+
/** The name of the file to be uploaded. The file extension in the name will be used as the
|
|
3509
|
+
extension of the imported entry. Required when startingPartNumber is 1 (first batch);
|
|
3510
|
+
ignored on subsequent batches. */
|
|
3511
|
+
fileName: string;
|
|
3512
|
+
/** The mime-type of the file to be uploaded. Required when startingPartNumber is 1
|
|
3513
|
+
(first batch); ignored on subsequent batches. */
|
|
3514
|
+
mimeType: string;
|
|
2745
3515
|
}
|
|
2746
3516
|
/** Response containing a long operation task id. */
|
|
2747
3517
|
export declare class StartTaskResponse implements IStartTaskResponse {
|
|
@@ -2767,9 +3537,11 @@ export declare class StartImportUploadedPartsRequest implements IStartImportUplo
|
|
|
2767
3537
|
name: string;
|
|
2768
3538
|
/** Indicates if the entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false. */
|
|
2769
3539
|
autoRename?: boolean;
|
|
2770
|
-
/**
|
|
3540
|
+
/** Server-side processing options applied to the imported file. See ImportEntryRequestPdfOptions for the full contract. */
|
|
2771
3541
|
pdfOptions?: ImportEntryRequestPdfOptions | undefined;
|
|
2772
|
-
/**
|
|
3542
|
+
/** Whether the file is imported as the electronic document (true) or as image pages (false). Default: false.
|
|
3543
|
+
This flag is only effective when the file extension is one of: txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png.
|
|
3544
|
+
For any other file type (PDF, Word, Excel, etc.), the file is always imported as the electronic document regardless of this flag. */
|
|
2773
3545
|
importAsElectronicDocument?: boolean;
|
|
2774
3546
|
/** The metadata that will be assigned to the entry. */
|
|
2775
3547
|
metadata?: ImportEntryRequestMetadata | undefined;
|
|
@@ -2790,39 +3562,51 @@ export interface IStartImportUploadedPartsRequest {
|
|
|
2790
3562
|
name: string;
|
|
2791
3563
|
/** Indicates if the entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false. */
|
|
2792
3564
|
autoRename?: boolean;
|
|
2793
|
-
/**
|
|
3565
|
+
/** Server-side processing options applied to the imported file. See ImportEntryRequestPdfOptions for the full contract. */
|
|
2794
3566
|
pdfOptions?: ImportEntryRequestPdfOptions | undefined;
|
|
2795
|
-
/**
|
|
3567
|
+
/** Whether the file is imported as the electronic document (true) or as image pages (false). Default: false.
|
|
3568
|
+
This flag is only effective when the file extension is one of: txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png.
|
|
3569
|
+
For any other file type (PDF, Word, Excel, etc.), the file is always imported as the electronic document regardless of this flag. */
|
|
2796
3570
|
importAsElectronicDocument?: boolean;
|
|
2797
3571
|
/** The metadata that will be assigned to the entry. */
|
|
2798
3572
|
metadata?: ImportEntryRequestMetadata | undefined;
|
|
2799
3573
|
/** The name of the volume to use. Will use the default parent entry volume if not specified. This is ignored in Laserfiche Cloud. */
|
|
2800
3574
|
volumeName?: string | undefined;
|
|
2801
3575
|
}
|
|
2802
|
-
/**
|
|
3576
|
+
/** Server-side processing options for the imported file. Despite the type name, these fields apply to any supported electronic document as well as to files imported as image pages. */
|
|
2803
3577
|
export declare class ImportEntryRequestPdfOptions implements IImportEntryRequestPdfOptions {
|
|
2804
|
-
/**
|
|
3578
|
+
/** Generate searchable text for the imported file. For electronic documents, text is extracted from
|
|
3579
|
+
the document (or OCR'd when the source is image-based). For files imported as image pages
|
|
3580
|
+
(image file type with importAsElectronicDocument=false), the pages are OCR'd. Default: false.
|
|
3581
|
+
Does not affect pages added via `imageFiles` — use `generateImagePagesText` for those. */
|
|
2805
3582
|
generateText?: boolean;
|
|
2806
|
-
/**
|
|
3583
|
+
/** Render server-side image pages from the electronic document. Applicable when the file is imported
|
|
3584
|
+
as an electronic document. Default: false. */
|
|
2807
3585
|
generatePages?: boolean;
|
|
2808
3586
|
/** The image type used when generating image pages. The default value is StandardColor. This option is only applicable when GeneratePages is true. */
|
|
2809
3587
|
generatePagesImageType?: GeneratePagesImageType;
|
|
2810
|
-
/**
|
|
3588
|
+
/** When GeneratePages is true, retain the original file as the electronic document.
|
|
3589
|
+
When false, only the generated image pages remain. Default: true. Ignored when GeneratePages=false. */
|
|
2811
3590
|
keepPdfAfterImport?: boolean;
|
|
2812
3591
|
constructor(data?: IImportEntryRequestPdfOptions);
|
|
2813
3592
|
init(_data?: any): void;
|
|
2814
3593
|
static fromJS(data: any): ImportEntryRequestPdfOptions;
|
|
2815
3594
|
toJSON(data?: any): any;
|
|
2816
3595
|
}
|
|
2817
|
-
/**
|
|
3596
|
+
/** Server-side processing options for the imported file. Despite the type name, these fields apply to any supported electronic document as well as to files imported as image pages. */
|
|
2818
3597
|
export interface IImportEntryRequestPdfOptions {
|
|
2819
|
-
/**
|
|
3598
|
+
/** Generate searchable text for the imported file. For electronic documents, text is extracted from
|
|
3599
|
+
the document (or OCR'd when the source is image-based). For files imported as image pages
|
|
3600
|
+
(image file type with importAsElectronicDocument=false), the pages are OCR'd. Default: false.
|
|
3601
|
+
Does not affect pages added via `imageFiles` — use `generateImagePagesText` for those. */
|
|
2820
3602
|
generateText?: boolean;
|
|
2821
|
-
/**
|
|
3603
|
+
/** Render server-side image pages from the electronic document. Applicable when the file is imported
|
|
3604
|
+
as an electronic document. Default: false. */
|
|
2822
3605
|
generatePages?: boolean;
|
|
2823
3606
|
/** The image type used when generating image pages. The default value is StandardColor. This option is only applicable when GeneratePages is true. */
|
|
2824
3607
|
generatePagesImageType?: GeneratePagesImageType;
|
|
2825
|
-
/**
|
|
3608
|
+
/** When GeneratePages is true, retain the original file as the electronic document.
|
|
3609
|
+
When false, only the generated image pages remain. Default: true. Ignored when GeneratePages=false. */
|
|
2826
3610
|
keepPdfAfterImport?: boolean;
|
|
2827
3611
|
}
|
|
2828
3612
|
/** Enumeration for the image types when generating pages. */
|
|
@@ -3241,6 +4025,22 @@ export declare class Document extends Entry implements IDocument {
|
|
|
3241
4025
|
isCheckedOut?: boolean;
|
|
3242
4026
|
/** A boolean indicating if the represented document is under version control. */
|
|
3243
4027
|
isUnderVersionControl?: boolean;
|
|
4028
|
+
/** A boolean indicating if the represented document has a persistent lock. */
|
|
4029
|
+
isLocked?: boolean;
|
|
4030
|
+
/** The account name of the persistent lock holder. Null if the document is not locked. */
|
|
4031
|
+
lockedBy?: string | undefined;
|
|
4032
|
+
/** A boolean indicating if the document is locked by a user other than the authenticated user.
|
|
4033
|
+
False if the document is not locked or is locked by the authenticated user.
|
|
4034
|
+
Only populated on single-entry GET, not in listing results. */
|
|
4035
|
+
isLockedByAnotherUser?: boolean;
|
|
4036
|
+
/** The version number of the document. 0 if the document is not under version control. */
|
|
4037
|
+
currentVersion?: number;
|
|
4038
|
+
/** The account name of the user who checked out the document. Null if the document is not checked out. */
|
|
4039
|
+
checkedOutBy?: string | undefined;
|
|
4040
|
+
/** A boolean indicating if the document is checked out by a user other than the authenticated user.
|
|
4041
|
+
False if the document is not checked out or is checked out by the authenticated user.
|
|
4042
|
+
Only populated on single-entry GET, not in listing results. */
|
|
4043
|
+
isCheckedOutByAnotherUser?: boolean;
|
|
3244
4044
|
constructor(data?: IDocument);
|
|
3245
4045
|
init(_data?: any): void;
|
|
3246
4046
|
static fromJS(data: any): Document;
|
|
@@ -3264,6 +4064,22 @@ export interface IDocument extends IEntry {
|
|
|
3264
4064
|
isCheckedOut?: boolean;
|
|
3265
4065
|
/** A boolean indicating if the represented document is under version control. */
|
|
3266
4066
|
isUnderVersionControl?: boolean;
|
|
4067
|
+
/** A boolean indicating if the represented document has a persistent lock. */
|
|
4068
|
+
isLocked?: boolean;
|
|
4069
|
+
/** The account name of the persistent lock holder. Null if the document is not locked. */
|
|
4070
|
+
lockedBy?: string | undefined;
|
|
4071
|
+
/** A boolean indicating if the document is locked by a user other than the authenticated user.
|
|
4072
|
+
False if the document is not locked or is locked by the authenticated user.
|
|
4073
|
+
Only populated on single-entry GET, not in listing results. */
|
|
4074
|
+
isLockedByAnotherUser?: boolean;
|
|
4075
|
+
/** The version number of the document. 0 if the document is not under version control. */
|
|
4076
|
+
currentVersion?: number;
|
|
4077
|
+
/** The account name of the user who checked out the document. Null if the document is not checked out. */
|
|
4078
|
+
checkedOutBy?: string | undefined;
|
|
4079
|
+
/** A boolean indicating if the document is checked out by a user other than the authenticated user.
|
|
4080
|
+
False if the document is not checked out or is checked out by the authenticated user.
|
|
4081
|
+
Only populated on single-entry GET, not in listing results. */
|
|
4082
|
+
isCheckedOutByAnotherUser?: boolean;
|
|
3267
4083
|
}
|
|
3268
4084
|
/** Represents an entry shortcut in a Laserfiche repository. */
|
|
3269
4085
|
export declare class Shortcut extends Entry implements IShortcut {
|
|
@@ -3305,196 +4121,6 @@ export interface IFolder extends IEntry {
|
|
|
3305
4121
|
/** A boolean indicating if the folder that this instance represents is known to directly or indirectly under a record series in the repository. */
|
|
3306
4122
|
isUnderRecordSeries?: boolean;
|
|
3307
4123
|
}
|
|
3308
|
-
export declare abstract class IHeaderDictionary implements IIHeaderDictionary {
|
|
3309
|
-
item?: any[];
|
|
3310
|
-
contentLength?: number | undefined;
|
|
3311
|
-
accept?: any[];
|
|
3312
|
-
acceptCharset?: any[];
|
|
3313
|
-
acceptEncoding?: any[];
|
|
3314
|
-
acceptLanguage?: any[];
|
|
3315
|
-
acceptRanges?: any[];
|
|
3316
|
-
accessControlAllowCredentials?: any[];
|
|
3317
|
-
accessControlAllowHeaders?: any[];
|
|
3318
|
-
accessControlAllowMethods?: any[];
|
|
3319
|
-
accessControlAllowOrigin?: any[];
|
|
3320
|
-
accessControlExposeHeaders?: any[];
|
|
3321
|
-
accessControlMaxAge?: any[];
|
|
3322
|
-
accessControlRequestHeaders?: any[];
|
|
3323
|
-
accessControlRequestMethod?: any[];
|
|
3324
|
-
age?: any[];
|
|
3325
|
-
allow?: any[];
|
|
3326
|
-
altSvc?: any[];
|
|
3327
|
-
authorization?: any[];
|
|
3328
|
-
baggage?: any[];
|
|
3329
|
-
cacheControl?: any[];
|
|
3330
|
-
connection?: any[];
|
|
3331
|
-
contentDisposition?: any[];
|
|
3332
|
-
contentEncoding?: any[];
|
|
3333
|
-
contentLanguage?: any[];
|
|
3334
|
-
contentLocation?: any[];
|
|
3335
|
-
contentMD5?: any[];
|
|
3336
|
-
contentRange?: any[];
|
|
3337
|
-
contentSecurityPolicy?: any[];
|
|
3338
|
-
contentSecurityPolicyReportOnly?: any[];
|
|
3339
|
-
contentType?: any[];
|
|
3340
|
-
correlationContext?: any[];
|
|
3341
|
-
cookie?: any[];
|
|
3342
|
-
date?: any[];
|
|
3343
|
-
eTag?: any[];
|
|
3344
|
-
expires?: any[];
|
|
3345
|
-
expect?: any[];
|
|
3346
|
-
from?: any[];
|
|
3347
|
-
grpcAcceptEncoding?: any[];
|
|
3348
|
-
grpcEncoding?: any[];
|
|
3349
|
-
grpcMessage?: any[];
|
|
3350
|
-
grpcStatus?: any[];
|
|
3351
|
-
grpcTimeout?: any[];
|
|
3352
|
-
host?: any[];
|
|
3353
|
-
keepAlive?: any[];
|
|
3354
|
-
ifMatch?: any[];
|
|
3355
|
-
ifModifiedSince?: any[];
|
|
3356
|
-
ifNoneMatch?: any[];
|
|
3357
|
-
ifRange?: any[];
|
|
3358
|
-
ifUnmodifiedSince?: any[];
|
|
3359
|
-
lastModified?: any[];
|
|
3360
|
-
link?: any[];
|
|
3361
|
-
location?: any[];
|
|
3362
|
-
maxForwards?: any[];
|
|
3363
|
-
origin?: any[];
|
|
3364
|
-
pragma?: any[];
|
|
3365
|
-
proxyAuthenticate?: any[];
|
|
3366
|
-
proxyAuthorization?: any[];
|
|
3367
|
-
proxyConnection?: any[];
|
|
3368
|
-
range?: any[];
|
|
3369
|
-
referer?: any[];
|
|
3370
|
-
retryAfter?: any[];
|
|
3371
|
-
requestId?: any[];
|
|
3372
|
-
secWebSocketAccept?: any[];
|
|
3373
|
-
secWebSocketKey?: any[];
|
|
3374
|
-
secWebSocketProtocol?: any[];
|
|
3375
|
-
secWebSocketVersion?: any[];
|
|
3376
|
-
secWebSocketExtensions?: any[];
|
|
3377
|
-
server?: any[];
|
|
3378
|
-
setCookie?: any[];
|
|
3379
|
-
strictTransportSecurity?: any[];
|
|
3380
|
-
tE?: any[];
|
|
3381
|
-
trailer?: any[];
|
|
3382
|
-
transferEncoding?: any[];
|
|
3383
|
-
translate?: any[];
|
|
3384
|
-
traceParent?: any[];
|
|
3385
|
-
traceState?: any[];
|
|
3386
|
-
upgrade?: any[];
|
|
3387
|
-
upgradeInsecureRequests?: any[];
|
|
3388
|
-
userAgent?: any[];
|
|
3389
|
-
vary?: any[];
|
|
3390
|
-
via?: any[];
|
|
3391
|
-
warning?: any[];
|
|
3392
|
-
webSocketSubProtocols?: any[];
|
|
3393
|
-
wWWAuthenticate?: any[];
|
|
3394
|
-
xContentTypeOptions?: any[];
|
|
3395
|
-
xFrameOptions?: any[];
|
|
3396
|
-
xPoweredBy?: any[];
|
|
3397
|
-
xRequestedWith?: any[];
|
|
3398
|
-
xUACompatible?: any[];
|
|
3399
|
-
xXSSProtection?: any[];
|
|
3400
|
-
constructor(data?: IIHeaderDictionary);
|
|
3401
|
-
init(_data?: any): void;
|
|
3402
|
-
static fromJS(data: any): IHeaderDictionary;
|
|
3403
|
-
toJSON(data?: any): any;
|
|
3404
|
-
}
|
|
3405
|
-
export interface IIHeaderDictionary {
|
|
3406
|
-
item?: any[];
|
|
3407
|
-
contentLength?: number | undefined;
|
|
3408
|
-
accept?: any[];
|
|
3409
|
-
acceptCharset?: any[];
|
|
3410
|
-
acceptEncoding?: any[];
|
|
3411
|
-
acceptLanguage?: any[];
|
|
3412
|
-
acceptRanges?: any[];
|
|
3413
|
-
accessControlAllowCredentials?: any[];
|
|
3414
|
-
accessControlAllowHeaders?: any[];
|
|
3415
|
-
accessControlAllowMethods?: any[];
|
|
3416
|
-
accessControlAllowOrigin?: any[];
|
|
3417
|
-
accessControlExposeHeaders?: any[];
|
|
3418
|
-
accessControlMaxAge?: any[];
|
|
3419
|
-
accessControlRequestHeaders?: any[];
|
|
3420
|
-
accessControlRequestMethod?: any[];
|
|
3421
|
-
age?: any[];
|
|
3422
|
-
allow?: any[];
|
|
3423
|
-
altSvc?: any[];
|
|
3424
|
-
authorization?: any[];
|
|
3425
|
-
baggage?: any[];
|
|
3426
|
-
cacheControl?: any[];
|
|
3427
|
-
connection?: any[];
|
|
3428
|
-
contentDisposition?: any[];
|
|
3429
|
-
contentEncoding?: any[];
|
|
3430
|
-
contentLanguage?: any[];
|
|
3431
|
-
contentLocation?: any[];
|
|
3432
|
-
contentMD5?: any[];
|
|
3433
|
-
contentRange?: any[];
|
|
3434
|
-
contentSecurityPolicy?: any[];
|
|
3435
|
-
contentSecurityPolicyReportOnly?: any[];
|
|
3436
|
-
contentType?: any[];
|
|
3437
|
-
correlationContext?: any[];
|
|
3438
|
-
cookie?: any[];
|
|
3439
|
-
date?: any[];
|
|
3440
|
-
eTag?: any[];
|
|
3441
|
-
expires?: any[];
|
|
3442
|
-
expect?: any[];
|
|
3443
|
-
from?: any[];
|
|
3444
|
-
grpcAcceptEncoding?: any[];
|
|
3445
|
-
grpcEncoding?: any[];
|
|
3446
|
-
grpcMessage?: any[];
|
|
3447
|
-
grpcStatus?: any[];
|
|
3448
|
-
grpcTimeout?: any[];
|
|
3449
|
-
host?: any[];
|
|
3450
|
-
keepAlive?: any[];
|
|
3451
|
-
ifMatch?: any[];
|
|
3452
|
-
ifModifiedSince?: any[];
|
|
3453
|
-
ifNoneMatch?: any[];
|
|
3454
|
-
ifRange?: any[];
|
|
3455
|
-
ifUnmodifiedSince?: any[];
|
|
3456
|
-
lastModified?: any[];
|
|
3457
|
-
link?: any[];
|
|
3458
|
-
location?: any[];
|
|
3459
|
-
maxForwards?: any[];
|
|
3460
|
-
origin?: any[];
|
|
3461
|
-
pragma?: any[];
|
|
3462
|
-
proxyAuthenticate?: any[];
|
|
3463
|
-
proxyAuthorization?: any[];
|
|
3464
|
-
proxyConnection?: any[];
|
|
3465
|
-
range?: any[];
|
|
3466
|
-
referer?: any[];
|
|
3467
|
-
retryAfter?: any[];
|
|
3468
|
-
requestId?: any[];
|
|
3469
|
-
secWebSocketAccept?: any[];
|
|
3470
|
-
secWebSocketKey?: any[];
|
|
3471
|
-
secWebSocketProtocol?: any[];
|
|
3472
|
-
secWebSocketVersion?: any[];
|
|
3473
|
-
secWebSocketExtensions?: any[];
|
|
3474
|
-
server?: any[];
|
|
3475
|
-
setCookie?: any[];
|
|
3476
|
-
strictTransportSecurity?: any[];
|
|
3477
|
-
tE?: any[];
|
|
3478
|
-
trailer?: any[];
|
|
3479
|
-
transferEncoding?: any[];
|
|
3480
|
-
translate?: any[];
|
|
3481
|
-
traceParent?: any[];
|
|
3482
|
-
traceState?: any[];
|
|
3483
|
-
upgrade?: any[];
|
|
3484
|
-
upgradeInsecureRequests?: any[];
|
|
3485
|
-
userAgent?: any[];
|
|
3486
|
-
vary?: any[];
|
|
3487
|
-
via?: any[];
|
|
3488
|
-
warning?: any[];
|
|
3489
|
-
webSocketSubProtocols?: any[];
|
|
3490
|
-
wWWAuthenticate?: any[];
|
|
3491
|
-
xContentTypeOptions?: any[];
|
|
3492
|
-
xFrameOptions?: any[];
|
|
3493
|
-
xPoweredBy?: any[];
|
|
3494
|
-
xRequestedWith?: any[];
|
|
3495
|
-
xUACompatible?: any[];
|
|
3496
|
-
xXSSProtection?: any[];
|
|
3497
|
-
}
|
|
3498
4124
|
/** Request body for importing an entry. */
|
|
3499
4125
|
export declare class ImportEntryRequest implements IImportEntryRequest {
|
|
3500
4126
|
/** The name for the imported entry. */
|
|
@@ -3503,12 +4129,17 @@ export declare class ImportEntryRequest implements IImportEntryRequest {
|
|
|
3503
4129
|
autoRename?: boolean;
|
|
3504
4130
|
/** The options applied when importing a PDF. */
|
|
3505
4131
|
pdfOptions?: ImportEntryRequestPdfOptions | undefined;
|
|
3506
|
-
/**
|
|
4132
|
+
/** Whether the file is imported as the electronic document (true) or as image pages (false). Default: false.
|
|
4133
|
+
This flag is only effective when the file extension is one of: txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png.
|
|
4134
|
+
For any other file type (PDF, Word, Excel, etc.), the file is always imported as the electronic document regardless of this flag. */
|
|
3507
4135
|
importAsElectronicDocument?: boolean;
|
|
3508
4136
|
/** The metadata that will be assigned to the entry. */
|
|
3509
4137
|
metadata?: ImportEntryRequestMetadata | undefined;
|
|
3510
4138
|
/** The name of the volume to use. Will use the default parent entry volume if not specified. This is ignored in Laserfiche Cloud. */
|
|
3511
4139
|
volumeName?: string | undefined;
|
|
4140
|
+
/** Whether to generate searchable text (OCR) for image pages added via `imageFiles`. Default: true.
|
|
4141
|
+
Does not affect pages generated from `file` — use `pdfOptions.generateText` for those. */
|
|
4142
|
+
generateImagePagesText?: boolean;
|
|
3512
4143
|
constructor(data?: IImportEntryRequest);
|
|
3513
4144
|
init(_data?: any): void;
|
|
3514
4145
|
static fromJS(data: any): ImportEntryRequest;
|
|
@@ -3522,16 +4153,22 @@ export interface IImportEntryRequest {
|
|
|
3522
4153
|
autoRename?: boolean;
|
|
3523
4154
|
/** The options applied when importing a PDF. */
|
|
3524
4155
|
pdfOptions?: ImportEntryRequestPdfOptions | undefined;
|
|
3525
|
-
/**
|
|
4156
|
+
/** Whether the file is imported as the electronic document (true) or as image pages (false). Default: false.
|
|
4157
|
+
This flag is only effective when the file extension is one of: txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png.
|
|
4158
|
+
For any other file type (PDF, Word, Excel, etc.), the file is always imported as the electronic document regardless of this flag. */
|
|
3526
4159
|
importAsElectronicDocument?: boolean;
|
|
3527
4160
|
/** The metadata that will be assigned to the entry. */
|
|
3528
4161
|
metadata?: ImportEntryRequestMetadata | undefined;
|
|
3529
4162
|
/** The name of the volume to use. Will use the default parent entry volume if not specified. This is ignored in Laserfiche Cloud. */
|
|
3530
4163
|
volumeName?: string | undefined;
|
|
4164
|
+
/** Whether to generate searchable text (OCR) for image pages added via `imageFiles`. Default: true.
|
|
4165
|
+
Does not affect pages generated from `file` — use `pdfOptions.generateText` for those. */
|
|
4166
|
+
generateImagePagesText?: boolean;
|
|
3531
4167
|
}
|
|
3532
4168
|
/** Response containing a link to download the exported entry. */
|
|
3533
4169
|
export declare class ExportEntryResponse implements IExportEntryResponse {
|
|
3534
|
-
value
|
|
4170
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4171
|
+
value?: string | undefined;
|
|
3535
4172
|
constructor(data?: IExportEntryResponse);
|
|
3536
4173
|
init(_data?: any): void;
|
|
3537
4174
|
static fromJS(data: any): ExportEntryResponse;
|
|
@@ -3539,7 +4176,8 @@ export declare class ExportEntryResponse implements IExportEntryResponse {
|
|
|
3539
4176
|
}
|
|
3540
4177
|
/** Response containing a link to download the exported entry. */
|
|
3541
4178
|
export interface IExportEntryResponse {
|
|
3542
|
-
value
|
|
4179
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4180
|
+
value?: string | undefined;
|
|
3543
4181
|
}
|
|
3544
4182
|
/** Request body for exporting an entry. */
|
|
3545
4183
|
export declare class ExportEntryRequest implements IExportEntryRequest {
|
|
@@ -3617,7 +4255,8 @@ export declare class EntryCollectionResponse implements IEntryCollectionResponse
|
|
|
3617
4255
|
odataNextLink?: string | undefined;
|
|
3618
4256
|
/** The total count of items within a collection. */
|
|
3619
4257
|
odataCount?: number | undefined;
|
|
3620
|
-
value
|
|
4258
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4259
|
+
value?: Entry[] | undefined;
|
|
3621
4260
|
constructor(data?: IEntryCollectionResponse);
|
|
3622
4261
|
init(_data?: any): void;
|
|
3623
4262
|
static fromJS(data: any): EntryCollectionResponse;
|
|
@@ -3629,7 +4268,8 @@ export interface IEntryCollectionResponse {
|
|
|
3629
4268
|
odataNextLink?: string | undefined;
|
|
3630
4269
|
/** The total count of items within a collection. */
|
|
3631
4270
|
odataCount?: number | undefined;
|
|
3632
|
-
value
|
|
4271
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4272
|
+
value?: Entry[] | undefined;
|
|
3633
4273
|
}
|
|
3634
4274
|
/** Response containing a collection of Field. */
|
|
3635
4275
|
export declare class FieldCollectionResponse implements IFieldCollectionResponse {
|
|
@@ -3637,7 +4277,8 @@ export declare class FieldCollectionResponse implements IFieldCollectionResponse
|
|
|
3637
4277
|
odataNextLink?: string | undefined;
|
|
3638
4278
|
/** The total count of items within a collection. */
|
|
3639
4279
|
odataCount?: number | undefined;
|
|
3640
|
-
value
|
|
4280
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4281
|
+
value?: Field[] | undefined;
|
|
3641
4282
|
constructor(data?: IFieldCollectionResponse);
|
|
3642
4283
|
init(_data?: any): void;
|
|
3643
4284
|
static fromJS(data: any): FieldCollectionResponse;
|
|
@@ -3649,7 +4290,8 @@ export interface IFieldCollectionResponse {
|
|
|
3649
4290
|
odataNextLink?: string | undefined;
|
|
3650
4291
|
/** The total count of items within a collection. */
|
|
3651
4292
|
odataCount?: number | undefined;
|
|
3652
|
-
value
|
|
4293
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4294
|
+
value?: Field[] | undefined;
|
|
3653
4295
|
}
|
|
3654
4296
|
/** Request body for assigning fields to an entry. */
|
|
3655
4297
|
export declare class SetFieldsRequest implements ISetFieldsRequest {
|
|
@@ -3671,7 +4313,8 @@ export declare class TagCollectionResponse implements ITagCollectionResponse {
|
|
|
3671
4313
|
odataNextLink?: string | undefined;
|
|
3672
4314
|
/** The total count of items within a collection. */
|
|
3673
4315
|
odataCount?: number | undefined;
|
|
3674
|
-
value
|
|
4316
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4317
|
+
value?: Tag[] | undefined;
|
|
3675
4318
|
constructor(data?: ITagCollectionResponse);
|
|
3676
4319
|
init(_data?: any): void;
|
|
3677
4320
|
static fromJS(data: any): TagCollectionResponse;
|
|
@@ -3683,7 +4326,8 @@ export interface ITagCollectionResponse {
|
|
|
3683
4326
|
odataNextLink?: string | undefined;
|
|
3684
4327
|
/** The total count of items within a collection. */
|
|
3685
4328
|
odataCount?: number | undefined;
|
|
3686
|
-
value
|
|
4329
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4330
|
+
value?: Tag[] | undefined;
|
|
3687
4331
|
}
|
|
3688
4332
|
/** Represents a tag set on an entry. */
|
|
3689
4333
|
export declare class Tag implements ITag {
|
|
@@ -3773,7 +4417,8 @@ export declare class LinkCollectionResponse implements ILinkCollectionResponse {
|
|
|
3773
4417
|
odataNextLink?: string | undefined;
|
|
3774
4418
|
/** The total count of items within a collection. */
|
|
3775
4419
|
odataCount?: number | undefined;
|
|
3776
|
-
value
|
|
4420
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4421
|
+
value?: Link[] | undefined;
|
|
3777
4422
|
constructor(data?: ILinkCollectionResponse);
|
|
3778
4423
|
init(_data?: any): void;
|
|
3779
4424
|
static fromJS(data: any): LinkCollectionResponse;
|
|
@@ -3785,7 +4430,8 @@ export interface ILinkCollectionResponse {
|
|
|
3785
4430
|
odataNextLink?: string | undefined;
|
|
3786
4431
|
/** The total count of items within a collection. */
|
|
3787
4432
|
odataCount?: number | undefined;
|
|
3788
|
-
value
|
|
4433
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4434
|
+
value?: Link[] | undefined;
|
|
3789
4435
|
}
|
|
3790
4436
|
/** Represents a link between a source entry and a target entry. */
|
|
3791
4437
|
export declare class Link implements ILink {
|
|
@@ -3928,6 +4574,226 @@ export declare enum CreateEntryRequestEntryType {
|
|
|
3928
4574
|
Folder = "Folder",
|
|
3929
4575
|
Shortcut = "Shortcut"
|
|
3930
4576
|
}
|
|
4577
|
+
/** Request body for updating a document's electronic document and/or metadata. */
|
|
4578
|
+
export declare class UpdateDocumentRequest implements IUpdateDocumentRequest {
|
|
4579
|
+
/** Whether a provided file is imported as the electronic document (true) or as image pages (false). Default: false.
|
|
4580
|
+
This flag is only effective when `file` is provided and its extension is one of: txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png.
|
|
4581
|
+
For any other file type (PDF, Word, Excel, etc.), the file is always imported as the electronic document regardless of this flag. */
|
|
4582
|
+
importAsElectronicDocument?: boolean;
|
|
4583
|
+
/** The metadata that will be assigned to the entry. Metadata updates are additive — only the specified fields, tags, and links are touched. Existing values not mentioned in the request are preserved. */
|
|
4584
|
+
metadata?: ImportEntryRequestMetadata | undefined;
|
|
4585
|
+
/** The options applied when importing a PDF. */
|
|
4586
|
+
pdfOptions?: ImportEntryRequestPdfOptions | undefined;
|
|
4587
|
+
/** Whether to generate searchable text (OCR) for image pages added via `imageFiles`. Default: true.
|
|
4588
|
+
Does not affect pages generated from `file` — use `pdfOptions.generateText` for those. */
|
|
4589
|
+
generateImagePagesText?: boolean;
|
|
4590
|
+
constructor(data?: IUpdateDocumentRequest);
|
|
4591
|
+
init(_data?: any): void;
|
|
4592
|
+
static fromJS(data: any): UpdateDocumentRequest;
|
|
4593
|
+
toJSON(data?: any): any;
|
|
4594
|
+
}
|
|
4595
|
+
/** Request body for updating a document's electronic document and/or metadata. */
|
|
4596
|
+
export interface IUpdateDocumentRequest {
|
|
4597
|
+
/** Whether a provided file is imported as the electronic document (true) or as image pages (false). Default: false.
|
|
4598
|
+
This flag is only effective when `file` is provided and its extension is one of: txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png.
|
|
4599
|
+
For any other file type (PDF, Word, Excel, etc.), the file is always imported as the electronic document regardless of this flag. */
|
|
4600
|
+
importAsElectronicDocument?: boolean;
|
|
4601
|
+
/** The metadata that will be assigned to the entry. Metadata updates are additive — only the specified fields, tags, and links are touched. Existing values not mentioned in the request are preserved. */
|
|
4602
|
+
metadata?: ImportEntryRequestMetadata | undefined;
|
|
4603
|
+
/** The options applied when importing a PDF. */
|
|
4604
|
+
pdfOptions?: ImportEntryRequestPdfOptions | undefined;
|
|
4605
|
+
/** Whether to generate searchable text (OCR) for image pages added via `imageFiles`. Default: true.
|
|
4606
|
+
Does not affect pages generated from `file` — use `pdfOptions.generateText` for those. */
|
|
4607
|
+
generateImagePagesText?: boolean;
|
|
4608
|
+
}
|
|
4609
|
+
/** Request body for updating a document's electronic document and/or metadata from previously uploaded parts. */
|
|
4610
|
+
export declare class UpdateDocumentUploadedPartsRequest implements IUpdateDocumentUploadedPartsRequest {
|
|
4611
|
+
/** The UploadId received when calling the CreateMultipartUploadUrls API to request upload URLs. */
|
|
4612
|
+
uploadId: string;
|
|
4613
|
+
/** The array of the ETag values received when writing the file chunks into the upload URLs. The ETag values should be in the order of their associated upload URLs. */
|
|
4614
|
+
partETags: string[];
|
|
4615
|
+
/** Whether the assembled file is imported as the electronic document (true) or as image pages (false). Default: false.
|
|
4616
|
+
This flag is only effective when the file extension is one of: txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png.
|
|
4617
|
+
For any other file type (PDF, Word, Excel, etc.), the file is always imported as the electronic document regardless of this flag. */
|
|
4618
|
+
importAsElectronicDocument?: boolean;
|
|
4619
|
+
/** The metadata that will be assigned to the entry. Metadata updates are additive — only the specified fields, tags, and links are touched. Existing values not mentioned in the request are preserved. */
|
|
4620
|
+
metadata?: ImportEntryRequestMetadata | undefined;
|
|
4621
|
+
/** Server-side processing options applied to the assembled file. See ImportEntryRequestPdfOptions for the full contract. */
|
|
4622
|
+
pdfOptions?: ImportEntryRequestPdfOptions | undefined;
|
|
4623
|
+
constructor(data?: IUpdateDocumentUploadedPartsRequest);
|
|
4624
|
+
init(_data?: any): void;
|
|
4625
|
+
static fromJS(data: any): UpdateDocumentUploadedPartsRequest;
|
|
4626
|
+
toJSON(data?: any): any;
|
|
4627
|
+
}
|
|
4628
|
+
/** Request body for updating a document's electronic document and/or metadata from previously uploaded parts. */
|
|
4629
|
+
export interface IUpdateDocumentUploadedPartsRequest {
|
|
4630
|
+
/** The UploadId received when calling the CreateMultipartUploadUrls API to request upload URLs. */
|
|
4631
|
+
uploadId: string;
|
|
4632
|
+
/** The array of the ETag values received when writing the file chunks into the upload URLs. The ETag values should be in the order of their associated upload URLs. */
|
|
4633
|
+
partETags: string[];
|
|
4634
|
+
/** Whether the assembled file is imported as the electronic document (true) or as image pages (false). Default: false.
|
|
4635
|
+
This flag is only effective when the file extension is one of: txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png.
|
|
4636
|
+
For any other file type (PDF, Word, Excel, etc.), the file is always imported as the electronic document regardless of this flag. */
|
|
4637
|
+
importAsElectronicDocument?: boolean;
|
|
4638
|
+
/** The metadata that will be assigned to the entry. Metadata updates are additive — only the specified fields, tags, and links are touched. Existing values not mentioned in the request are preserved. */
|
|
4639
|
+
metadata?: ImportEntryRequestMetadata | undefined;
|
|
4640
|
+
/** Server-side processing options applied to the assembled file. See ImportEntryRequestPdfOptions for the full contract. */
|
|
4641
|
+
pdfOptions?: ImportEntryRequestPdfOptions | undefined;
|
|
4642
|
+
}
|
|
4643
|
+
/** Request body for POST /Document/Pages (CreatePages) and PUT /Document/Pages (ReplacePages). Carries the textual page content alongside any uploaded image files. */
|
|
4644
|
+
export declare class PagesContentRequest implements IPagesContentRequest {
|
|
4645
|
+
/** Optional text content for new pages. Paired by index with imageFiles —
|
|
4646
|
+
page[i] gets textPages[i] and imageFiles[i]. If one array is shorter,
|
|
4647
|
+
the corresponding pages are created without that part. */
|
|
4648
|
+
textPages?: string[] | undefined;
|
|
4649
|
+
constructor(data?: IPagesContentRequest);
|
|
4650
|
+
init(_data?: any): void;
|
|
4651
|
+
static fromJS(data: any): PagesContentRequest;
|
|
4652
|
+
toJSON(data?: any): any;
|
|
4653
|
+
}
|
|
4654
|
+
/** Request body for POST /Document/Pages (CreatePages) and PUT /Document/Pages (ReplacePages). Carries the textual page content alongside any uploaded image files. */
|
|
4655
|
+
export interface IPagesContentRequest {
|
|
4656
|
+
/** Optional text content for new pages. Paired by index with imageFiles —
|
|
4657
|
+
page[i] gets textPages[i] and imageFiles[i]. If one array is shorter,
|
|
4658
|
+
the corresponding pages are created without that part. */
|
|
4659
|
+
textPages?: string[] | undefined;
|
|
4660
|
+
}
|
|
4661
|
+
export declare class WritePageTextRequest implements IWritePageTextRequest {
|
|
4662
|
+
/** The text content for the page. */
|
|
4663
|
+
text: string;
|
|
4664
|
+
constructor(data?: IWritePageTextRequest);
|
|
4665
|
+
init(_data?: any): void;
|
|
4666
|
+
static fromJS(data: any): WritePageTextRequest;
|
|
4667
|
+
toJSON(data?: any): any;
|
|
4668
|
+
}
|
|
4669
|
+
export interface IWritePageTextRequest {
|
|
4670
|
+
/** The text content for the page. */
|
|
4671
|
+
text: string;
|
|
4672
|
+
}
|
|
4673
|
+
export declare class MovePagesRequest implements IMovePagesRequest {
|
|
4674
|
+
/** The page range to move (e.g., "1-3" or "2,4,6"). 1-based page numbers. */
|
|
4675
|
+
pageRange: string;
|
|
4676
|
+
/** The 1-based destination page number. Pages will be moved before this position. */
|
|
4677
|
+
destinationPageNumber: number;
|
|
4678
|
+
constructor(data?: IMovePagesRequest);
|
|
4679
|
+
init(_data?: any): void;
|
|
4680
|
+
static fromJS(data: any): MovePagesRequest;
|
|
4681
|
+
toJSON(data?: any): any;
|
|
4682
|
+
}
|
|
4683
|
+
export interface IMovePagesRequest {
|
|
4684
|
+
/** The page range to move (e.g., "1-3" or "2,4,6"). 1-based page numbers. */
|
|
4685
|
+
pageRange: string;
|
|
4686
|
+
/** The 1-based destination page number. Pages will be moved before this position. */
|
|
4687
|
+
destinationPageNumber: number;
|
|
4688
|
+
}
|
|
4689
|
+
export declare class CopyPagesRequest implements ICopyPagesRequest {
|
|
4690
|
+
/** The page range to copy (e.g., "1-3" or "2,4,6"). 1-based page numbers.
|
|
4691
|
+
The total number of distinct pages in the range cannot exceed 500. */
|
|
4692
|
+
pageRange: string;
|
|
4693
|
+
/** The entry ID of the destination document. */
|
|
4694
|
+
destinationEntryId: number;
|
|
4695
|
+
/** The 1-based page number in the destination document. Pages will be inserted before this position. */
|
|
4696
|
+
destinationPageNumber: number;
|
|
4697
|
+
constructor(data?: ICopyPagesRequest);
|
|
4698
|
+
init(_data?: any): void;
|
|
4699
|
+
static fromJS(data: any): CopyPagesRequest;
|
|
4700
|
+
toJSON(data?: any): any;
|
|
4701
|
+
}
|
|
4702
|
+
export interface ICopyPagesRequest {
|
|
4703
|
+
/** The page range to copy (e.g., "1-3" or "2,4,6"). 1-based page numbers.
|
|
4704
|
+
The total number of distinct pages in the range cannot exceed 500. */
|
|
4705
|
+
pageRange: string;
|
|
4706
|
+
/** The entry ID of the destination document. */
|
|
4707
|
+
destinationEntryId: number;
|
|
4708
|
+
/** The 1-based page number in the destination document. Pages will be inserted before this position. */
|
|
4709
|
+
destinationPageNumber: number;
|
|
4710
|
+
}
|
|
4711
|
+
export declare class RotateImagePageRequest implements IRotateImagePageRequest {
|
|
4712
|
+
/** The rotation angle in degrees. Accepted values: 0, 90, 180, 270. */
|
|
4713
|
+
rotationAngle: number;
|
|
4714
|
+
constructor(data?: IRotateImagePageRequest);
|
|
4715
|
+
init(_data?: any): void;
|
|
4716
|
+
static fromJS(data: any): RotateImagePageRequest;
|
|
4717
|
+
toJSON(data?: any): any;
|
|
4718
|
+
}
|
|
4719
|
+
export interface IRotateImagePageRequest {
|
|
4720
|
+
/** The rotation angle in degrees. Accepted values: 0, 90, 180, 270. */
|
|
4721
|
+
rotationAngle: number;
|
|
4722
|
+
}
|
|
4723
|
+
/** Response containing a collection of PageInfoResponse. */
|
|
4724
|
+
export declare class PageInfoCollectionResponse implements IPageInfoCollectionResponse {
|
|
4725
|
+
/** A URL to retrieve the next page of the requested collection. */
|
|
4726
|
+
odataNextLink?: string | undefined;
|
|
4727
|
+
/** The total count of items within a collection. */
|
|
4728
|
+
odataCount?: number | undefined;
|
|
4729
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4730
|
+
value?: PageInfoResponse[] | undefined;
|
|
4731
|
+
constructor(data?: IPageInfoCollectionResponse);
|
|
4732
|
+
init(_data?: any): void;
|
|
4733
|
+
static fromJS(data: any): PageInfoCollectionResponse;
|
|
4734
|
+
toJSON(data?: any): any;
|
|
4735
|
+
}
|
|
4736
|
+
/** Response containing a collection of PageInfoResponse. */
|
|
4737
|
+
export interface IPageInfoCollectionResponse {
|
|
4738
|
+
/** A URL to retrieve the next page of the requested collection. */
|
|
4739
|
+
odataNextLink?: string | undefined;
|
|
4740
|
+
/** The total count of items within a collection. */
|
|
4741
|
+
odataCount?: number | undefined;
|
|
4742
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4743
|
+
value?: PageInfoResponse[] | undefined;
|
|
4744
|
+
}
|
|
4745
|
+
export declare class PageInfoResponse implements IPageInfoResponse {
|
|
4746
|
+
entryId?: number;
|
|
4747
|
+
pageId?: number;
|
|
4748
|
+
pageNumber?: number;
|
|
4749
|
+
hasImage?: boolean;
|
|
4750
|
+
hasText?: boolean;
|
|
4751
|
+
hasThumbnail?: boolean;
|
|
4752
|
+
hasWordLocations?: boolean;
|
|
4753
|
+
imageRotationAngle?: number;
|
|
4754
|
+
imageDataSize?: number;
|
|
4755
|
+
textDataSize?: number;
|
|
4756
|
+
locationsDataSize?: number;
|
|
4757
|
+
thumbnailDataSize?: number;
|
|
4758
|
+
imageDepth?: number;
|
|
4759
|
+
imageHeight?: number;
|
|
4760
|
+
imageWidth?: number;
|
|
4761
|
+
imageXResolution?: number;
|
|
4762
|
+
imageYResolution?: number;
|
|
4763
|
+
constructor(data?: IPageInfoResponse);
|
|
4764
|
+
init(_data?: any): void;
|
|
4765
|
+
static fromJS(data: any): PageInfoResponse;
|
|
4766
|
+
toJSON(data?: any): any;
|
|
4767
|
+
}
|
|
4768
|
+
export interface IPageInfoResponse {
|
|
4769
|
+
entryId?: number;
|
|
4770
|
+
pageId?: number;
|
|
4771
|
+
pageNumber?: number;
|
|
4772
|
+
hasImage?: boolean;
|
|
4773
|
+
hasText?: boolean;
|
|
4774
|
+
hasThumbnail?: boolean;
|
|
4775
|
+
hasWordLocations?: boolean;
|
|
4776
|
+
imageRotationAngle?: number;
|
|
4777
|
+
imageDataSize?: number;
|
|
4778
|
+
textDataSize?: number;
|
|
4779
|
+
locationsDataSize?: number;
|
|
4780
|
+
thumbnailDataSize?: number;
|
|
4781
|
+
imageDepth?: number;
|
|
4782
|
+
imageHeight?: number;
|
|
4783
|
+
imageWidth?: number;
|
|
4784
|
+
imageXResolution?: number;
|
|
4785
|
+
imageYResolution?: number;
|
|
4786
|
+
}
|
|
4787
|
+
export declare class PageTextResponse implements IPageTextResponse {
|
|
4788
|
+
text?: string | undefined;
|
|
4789
|
+
constructor(data?: IPageTextResponse);
|
|
4790
|
+
init(_data?: any): void;
|
|
4791
|
+
static fromJS(data: any): PageTextResponse;
|
|
4792
|
+
toJSON(data?: any): any;
|
|
4793
|
+
}
|
|
4794
|
+
export interface IPageTextResponse {
|
|
4795
|
+
text?: string | undefined;
|
|
4796
|
+
}
|
|
3931
4797
|
/** Request body for listing dynamic field values for an entry. */
|
|
3932
4798
|
export declare class ListDynamicFieldValuesRequest implements IListDynamicFieldValuesRequest {
|
|
3933
4799
|
/** The template id. */
|
|
@@ -3968,9 +4834,103 @@ export interface ISetTemplateRequest {
|
|
|
3968
4834
|
/** The template fields that will be assigned to the entry. */
|
|
3969
4835
|
fields?: FieldToUpdate[] | undefined;
|
|
3970
4836
|
}
|
|
4837
|
+
export declare class LockInfo implements ILockInfo {
|
|
4838
|
+
/** The unique lock token. */
|
|
4839
|
+
lockToken?: string | undefined;
|
|
4840
|
+
/** The account name of the lock owner (e.g., "DOMAIN\user"). */
|
|
4841
|
+
owner?: string | undefined;
|
|
4842
|
+
/** The user-defined comment for the lock. */
|
|
4843
|
+
comment?: string | undefined;
|
|
4844
|
+
/** The lock extent (e.g., "Page", "Edoc", "Metadata", "All"). */
|
|
4845
|
+
extent?: string | undefined;
|
|
4846
|
+
/** The UTC timestamp when the lock was created. */
|
|
4847
|
+
creationTimestampUtc?: Date | undefined;
|
|
4848
|
+
/** The entry ID of the locked document. */
|
|
4849
|
+
entryId?: number;
|
|
4850
|
+
/** Whether the lock is currently active. */
|
|
4851
|
+
isActive?: boolean;
|
|
4852
|
+
constructor(data?: ILockInfo);
|
|
4853
|
+
init(_data?: any): void;
|
|
4854
|
+
static fromJS(data: any): LockInfo;
|
|
4855
|
+
toJSON(data?: any): any;
|
|
4856
|
+
}
|
|
4857
|
+
export interface ILockInfo {
|
|
4858
|
+
/** The unique lock token. */
|
|
4859
|
+
lockToken?: string | undefined;
|
|
4860
|
+
/** The account name of the lock owner (e.g., "DOMAIN\user"). */
|
|
4861
|
+
owner?: string | undefined;
|
|
4862
|
+
/** The user-defined comment for the lock. */
|
|
4863
|
+
comment?: string | undefined;
|
|
4864
|
+
/** The lock extent (e.g., "Page", "Edoc", "Metadata", "All"). */
|
|
4865
|
+
extent?: string | undefined;
|
|
4866
|
+
/** The UTC timestamp when the lock was created. */
|
|
4867
|
+
creationTimestampUtc?: Date | undefined;
|
|
4868
|
+
/** The entry ID of the locked document. */
|
|
4869
|
+
entryId?: number;
|
|
4870
|
+
/** Whether the lock is currently active. */
|
|
4871
|
+
isActive?: boolean;
|
|
4872
|
+
}
|
|
4873
|
+
/** Request body for creating a persistent lock on a document. */
|
|
4874
|
+
export declare class LockDocumentRequest implements ILockDocumentRequest {
|
|
4875
|
+
/** An optional comment for the persistent lock. */
|
|
4876
|
+
comment?: string | undefined;
|
|
4877
|
+
/** The lock extent. Defaults to All when omitted. */
|
|
4878
|
+
extent?: LockExtent | undefined;
|
|
4879
|
+
constructor(data?: ILockDocumentRequest);
|
|
4880
|
+
init(_data?: any): void;
|
|
4881
|
+
static fromJS(data: any): LockDocumentRequest;
|
|
4882
|
+
toJSON(data?: any): any;
|
|
4883
|
+
}
|
|
4884
|
+
/** Request body for creating a persistent lock on a document. */
|
|
4885
|
+
export interface ILockDocumentRequest {
|
|
4886
|
+
/** An optional comment for the persistent lock. */
|
|
4887
|
+
comment?: string | undefined;
|
|
4888
|
+
/** The lock extent. Defaults to All when omitted. */
|
|
4889
|
+
extent?: LockExtent | undefined;
|
|
4890
|
+
}
|
|
4891
|
+
/** The portion of a document that a persistent lock covers. */
|
|
4892
|
+
export declare enum LockExtent {
|
|
4893
|
+
Page = "Page",
|
|
4894
|
+
Edoc = "Edoc",
|
|
4895
|
+
Metadata = "Metadata",
|
|
4896
|
+
All = "All"
|
|
4897
|
+
}
|
|
4898
|
+
/** Request body for checking out a document. */
|
|
4899
|
+
export declare class CheckOutDocumentRequest implements ICheckOutDocumentRequest {
|
|
4900
|
+
/** Whether to automatically acquire a persistent lock as part of the check-out. Defaults to true. */
|
|
4901
|
+
lock?: boolean;
|
|
4902
|
+
/** An optional comment for the check-out. */
|
|
4903
|
+
comment?: string | undefined;
|
|
4904
|
+
constructor(data?: ICheckOutDocumentRequest);
|
|
4905
|
+
init(_data?: any): void;
|
|
4906
|
+
static fromJS(data: any): CheckOutDocumentRequest;
|
|
4907
|
+
toJSON(data?: any): any;
|
|
4908
|
+
}
|
|
4909
|
+
/** Request body for checking out a document. */
|
|
4910
|
+
export interface ICheckOutDocumentRequest {
|
|
4911
|
+
/** Whether to automatically acquire a persistent lock as part of the check-out. Defaults to true. */
|
|
4912
|
+
lock?: boolean;
|
|
4913
|
+
/** An optional comment for the check-out. */
|
|
4914
|
+
comment?: string | undefined;
|
|
4915
|
+
}
|
|
4916
|
+
/** Request body for checking in a document. */
|
|
4917
|
+
export declare class CheckInDocumentRequest implements ICheckInDocumentRequest {
|
|
4918
|
+
/** Whether to automatically release the persistent lock as part of the check-in. Defaults to true. */
|
|
4919
|
+
unlock?: boolean;
|
|
4920
|
+
constructor(data?: ICheckInDocumentRequest);
|
|
4921
|
+
init(_data?: any): void;
|
|
4922
|
+
static fromJS(data: any): CheckInDocumentRequest;
|
|
4923
|
+
toJSON(data?: any): any;
|
|
4924
|
+
}
|
|
4925
|
+
/** Request body for checking in a document. */
|
|
4926
|
+
export interface ICheckInDocumentRequest {
|
|
4927
|
+
/** Whether to automatically release the persistent lock as part of the check-in. Defaults to true. */
|
|
4928
|
+
unlock?: boolean;
|
|
4929
|
+
}
|
|
3971
4930
|
/** Response containing a collection of Repository. */
|
|
3972
4931
|
export declare class RepositoryCollectionResponse implements IRepositoryCollectionResponse {
|
|
3973
|
-
value
|
|
4932
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4933
|
+
value?: Repository[] | undefined;
|
|
3974
4934
|
constructor(data?: IRepositoryCollectionResponse);
|
|
3975
4935
|
init(_data?: any): void;
|
|
3976
4936
|
static fromJS(data: any): RepositoryCollectionResponse;
|
|
@@ -3978,7 +4938,8 @@ export declare class RepositoryCollectionResponse implements IRepositoryCollecti
|
|
|
3978
4938
|
}
|
|
3979
4939
|
/** Response containing a collection of Repository. */
|
|
3980
4940
|
export interface IRepositoryCollectionResponse {
|
|
3981
|
-
value
|
|
4941
|
+
/** Gets or sets the OData response content in the "value". */
|
|
4942
|
+
value?: Repository[] | undefined;
|
|
3982
4943
|
}
|
|
3983
4944
|
/** Represents a Laserfiche repository. */
|
|
3984
4945
|
export declare class Repository implements IRepository {
|
|
@@ -4035,7 +4996,8 @@ export declare class SearchContextHitCollectionResponse implements ISearchContex
|
|
|
4035
4996
|
odataNextLink?: string | undefined;
|
|
4036
4997
|
/** The total count of items within a collection. */
|
|
4037
4998
|
odataCount?: number | undefined;
|
|
4038
|
-
value
|
|
4999
|
+
/** Gets or sets the OData response content in the "value". */
|
|
5000
|
+
value?: SearchContextHit[] | undefined;
|
|
4039
5001
|
constructor(data?: ISearchContextHitCollectionResponse);
|
|
4040
5002
|
init(_data?: any): void;
|
|
4041
5003
|
static fromJS(data: any): SearchContextHitCollectionResponse;
|
|
@@ -4047,7 +5009,8 @@ export interface ISearchContextHitCollectionResponse {
|
|
|
4047
5009
|
odataNextLink?: string | undefined;
|
|
4048
5010
|
/** The total count of items within a collection. */
|
|
4049
5011
|
odataCount?: number | undefined;
|
|
4050
|
-
value
|
|
5012
|
+
/** Gets or sets the OData response content in the "value". */
|
|
5013
|
+
value?: SearchContextHit[] | undefined;
|
|
4051
5014
|
}
|
|
4052
5015
|
/** Represents a context hit for a search result. */
|
|
4053
5016
|
export declare class SearchContextHit implements ISearchContextHit {
|
|
@@ -4158,7 +5121,8 @@ export declare class TagDefinitionCollectionResponse implements ITagDefinitionCo
|
|
|
4158
5121
|
odataNextLink?: string | undefined;
|
|
4159
5122
|
/** The total count of items within a collection. */
|
|
4160
5123
|
odataCount?: number | undefined;
|
|
4161
|
-
value
|
|
5124
|
+
/** Gets or sets the OData response content in the "value". */
|
|
5125
|
+
value?: TagDefinition[] | undefined;
|
|
4162
5126
|
constructor(data?: ITagDefinitionCollectionResponse);
|
|
4163
5127
|
init(_data?: any): void;
|
|
4164
5128
|
static fromJS(data: any): TagDefinitionCollectionResponse;
|
|
@@ -4170,7 +5134,8 @@ export interface ITagDefinitionCollectionResponse {
|
|
|
4170
5134
|
odataNextLink?: string | undefined;
|
|
4171
5135
|
/** The total count of items within a collection. */
|
|
4172
5136
|
odataCount?: number | undefined;
|
|
4173
|
-
value
|
|
5137
|
+
/** Gets or sets the OData response content in the "value". */
|
|
5138
|
+
value?: TagDefinition[] | undefined;
|
|
4174
5139
|
}
|
|
4175
5140
|
/** Represents an entry tag definition. */
|
|
4176
5141
|
export declare class TagDefinition implements ITagDefinition {
|
|
@@ -4208,7 +5173,8 @@ export interface ITagDefinition {
|
|
|
4208
5173
|
}
|
|
4209
5174
|
/** Response containing a collection of TaskProgress. */
|
|
4210
5175
|
export declare class TaskCollectionResponse implements ITaskCollectionResponse {
|
|
4211
|
-
value
|
|
5176
|
+
/** Gets or sets the OData response content in the "value". */
|
|
5177
|
+
value?: TaskProgress[] | undefined;
|
|
4212
5178
|
constructor(data?: ITaskCollectionResponse);
|
|
4213
5179
|
init(_data?: any): void;
|
|
4214
5180
|
static fromJS(data: any): TaskCollectionResponse;
|
|
@@ -4216,7 +5182,8 @@ export declare class TaskCollectionResponse implements ITaskCollectionResponse {
|
|
|
4216
5182
|
}
|
|
4217
5183
|
/** Response containing a collection of TaskProgress. */
|
|
4218
5184
|
export interface ITaskCollectionResponse {
|
|
4219
|
-
value
|
|
5185
|
+
/** Gets or sets the OData response content in the "value". */
|
|
5186
|
+
value?: TaskProgress[] | undefined;
|
|
4220
5187
|
}
|
|
4221
5188
|
/** Represents the progress of a long operation task. */
|
|
4222
5189
|
export declare class TaskProgress implements ITaskProgress {
|
|
@@ -4296,7 +5263,8 @@ export interface ITaskResult {
|
|
|
4296
5263
|
}
|
|
4297
5264
|
/** Response containing a collection of CancelTaskResult. */
|
|
4298
5265
|
export declare class CancelTasksResponse implements ICancelTasksResponse {
|
|
4299
|
-
value
|
|
5266
|
+
/** Gets or sets the OData response content in the "value". */
|
|
5267
|
+
value?: CancelTaskResult[] | undefined;
|
|
4300
5268
|
constructor(data?: ICancelTasksResponse);
|
|
4301
5269
|
init(_data?: any): void;
|
|
4302
5270
|
static fromJS(data: any): CancelTasksResponse;
|
|
@@ -4304,7 +5272,8 @@ export declare class CancelTasksResponse implements ICancelTasksResponse {
|
|
|
4304
5272
|
}
|
|
4305
5273
|
/** Response containing a collection of CancelTaskResult. */
|
|
4306
5274
|
export interface ICancelTasksResponse {
|
|
4307
|
-
value
|
|
5275
|
+
/** Gets or sets the OData response content in the "value". */
|
|
5276
|
+
value?: CancelTaskResult[] | undefined;
|
|
4308
5277
|
}
|
|
4309
5278
|
/** Represents the result of cancelling a long operation task. */
|
|
4310
5279
|
export declare class CancelTaskResult implements ICancelTaskResult {
|
|
@@ -4334,7 +5303,8 @@ export declare class TemplateDefinitionCollectionResponse implements ITemplateDe
|
|
|
4334
5303
|
odataNextLink?: string | undefined;
|
|
4335
5304
|
/** The total count of items within a collection. */
|
|
4336
5305
|
odataCount?: number | undefined;
|
|
4337
|
-
value
|
|
5306
|
+
/** Gets or sets the OData response content in the "value". */
|
|
5307
|
+
value?: TemplateDefinition[] | undefined;
|
|
4338
5308
|
constructor(data?: ITemplateDefinitionCollectionResponse);
|
|
4339
5309
|
init(_data?: any): void;
|
|
4340
5310
|
static fromJS(data: any): TemplateDefinitionCollectionResponse;
|
|
@@ -4346,7 +5316,8 @@ export interface ITemplateDefinitionCollectionResponse {
|
|
|
4346
5316
|
odataNextLink?: string | undefined;
|
|
4347
5317
|
/** The total count of items within a collection. */
|
|
4348
5318
|
odataCount?: number | undefined;
|
|
4349
|
-
value
|
|
5319
|
+
/** Gets or sets the OData response content in the "value". */
|
|
5320
|
+
value?: TemplateDefinition[] | undefined;
|
|
4350
5321
|
}
|
|
4351
5322
|
/** Represents a template definition. */
|
|
4352
5323
|
export declare class TemplateDefinition implements ITemplateDefinition {
|
|
@@ -4414,7 +5385,8 @@ export declare class TemplateFieldDefinitionCollectionResponse implements ITempl
|
|
|
4414
5385
|
odataNextLink?: string | undefined;
|
|
4415
5386
|
/** The total count of items within a collection. */
|
|
4416
5387
|
odataCount?: number | undefined;
|
|
4417
|
-
value
|
|
5388
|
+
/** Gets or sets the OData response content in the "value". */
|
|
5389
|
+
value?: TemplateFieldDefinition[] | undefined;
|
|
4418
5390
|
constructor(data?: ITemplateFieldDefinitionCollectionResponse);
|
|
4419
5391
|
init(_data?: any): void;
|
|
4420
5392
|
static fromJS(data: any): TemplateFieldDefinitionCollectionResponse;
|
|
@@ -4426,7 +5398,8 @@ export interface ITemplateFieldDefinitionCollectionResponse {
|
|
|
4426
5398
|
odataNextLink?: string | undefined;
|
|
4427
5399
|
/** The total count of items within a collection. */
|
|
4428
5400
|
odataCount?: number | undefined;
|
|
4429
|
-
value
|
|
5401
|
+
/** Gets or sets the OData response content in the "value". */
|
|
5402
|
+
value?: TemplateFieldDefinition[] | undefined;
|
|
4430
5403
|
}
|
|
4431
5404
|
/** Represents a template field definition. */
|
|
4432
5405
|
export declare class TemplateFieldDefinition extends FieldDefinition implements ITemplateFieldDefinition {
|
|
@@ -4468,6 +5441,14 @@ export interface FileParameter {
|
|
|
4468
5441
|
data: any;
|
|
4469
5442
|
fileName: string;
|
|
4470
5443
|
}
|
|
5444
|
+
export interface FileResponse {
|
|
5445
|
+
data: Blob;
|
|
5446
|
+
status: number;
|
|
5447
|
+
fileName?: string;
|
|
5448
|
+
headers?: {
|
|
5449
|
+
[name: string]: any;
|
|
5450
|
+
};
|
|
5451
|
+
}
|
|
4471
5452
|
export interface IRepositoryApiClient {
|
|
4472
5453
|
attributesClient: IAttributesClient;
|
|
4473
5454
|
auditReasonsClient: IAuditReasonsClient;
|