@laserfiche/lf-repository-api-client-v2 1.3.0 → 1.4.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 +42 -0
- package/dist/index.js +40 -19
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1652,6 +1652,7 @@ export interface IEntriesClient {
|
|
|
1652
1652
|
* @param args.repositoryId The requested repository ID.
|
|
1653
1653
|
* @param args.entryId The entry ID of the folder that the document will be created in.
|
|
1654
1654
|
* @param args.request (optional) The request body.
|
|
1655
|
+
* @param args.autoCreateFolderPath (optional) When true, any missing folders in the request's `folderPath` are created; when false (default), a missing folder returns 404.
|
|
1655
1656
|
* @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.
|
|
1656
1657
|
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
1657
1658
|
*/
|
|
@@ -1659,6 +1660,7 @@ export interface IEntriesClient {
|
|
|
1659
1660
|
repositoryId: string;
|
|
1660
1661
|
entryId: number;
|
|
1661
1662
|
request?: StartImportUploadedPartsRequest | undefined;
|
|
1663
|
+
autoCreateFolderPath?: boolean | undefined;
|
|
1662
1664
|
culture?: string | null | undefined;
|
|
1663
1665
|
}): Promise<StartTaskResponse>;
|
|
1664
1666
|
/**
|
|
@@ -1763,6 +1765,7 @@ export interface IEntriesClient {
|
|
|
1763
1765
|
- Required OAuth scope: repository.Write
|
|
1764
1766
|
* @param args.repositoryId The requested repository ID.
|
|
1765
1767
|
* @param args.entryId The entry ID of the folder that the document will be created in.
|
|
1768
|
+
* @param args.autoCreateFolderPath (optional) When true, any missing folders in the request's `folderPath` are created; when false (default), a missing folder returns 404.
|
|
1766
1769
|
* @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.
|
|
1767
1770
|
* @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.
|
|
1768
1771
|
* @param args.request (optional)
|
|
@@ -1772,6 +1775,7 @@ export interface IEntriesClient {
|
|
|
1772
1775
|
importEntry(args: {
|
|
1773
1776
|
repositoryId: string;
|
|
1774
1777
|
entryId: number;
|
|
1778
|
+
autoCreateFolderPath?: boolean | undefined;
|
|
1775
1779
|
culture?: string | null | undefined;
|
|
1776
1780
|
file?: FileParameter | undefined;
|
|
1777
1781
|
request?: ImportEntryRequest | undefined;
|
|
@@ -1850,6 +1854,7 @@ export interface IEntriesClient {
|
|
|
1850
1854
|
* @param args.repositoryId The requested repository ID.
|
|
1851
1855
|
* @param args.entryId The folder ID that the entry will be created in.
|
|
1852
1856
|
* @param args.request The request body.
|
|
1857
|
+
* @param args.autoCreateFolderPath (optional) When true, any missing folders in the request's `folderPath` are created; when false (default), a missing folder returns 404.
|
|
1853
1858
|
* @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.
|
|
1854
1859
|
* @returns Document was created successfully. Returns created entry.
|
|
1855
1860
|
*/
|
|
@@ -1857,6 +1862,7 @@ export interface IEntriesClient {
|
|
|
1857
1862
|
repositoryId: string;
|
|
1858
1863
|
entryId: number;
|
|
1859
1864
|
request: CreateEntryRequest;
|
|
1865
|
+
autoCreateFolderPath?: boolean | undefined;
|
|
1860
1866
|
culture?: string | null | undefined;
|
|
1861
1867
|
}): Promise<Entry>;
|
|
1862
1868
|
/**
|
|
@@ -2612,6 +2618,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
2612
2618
|
* @param args.repositoryId The requested repository ID.
|
|
2613
2619
|
* @param args.entryId The entry ID of the folder that the document will be created in.
|
|
2614
2620
|
* @param args.request (optional) The request body.
|
|
2621
|
+
* @param args.autoCreateFolderPath (optional) When true, any missing folders in the request's `folderPath` are created; when false (default), a missing folder returns 404.
|
|
2615
2622
|
* @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.
|
|
2616
2623
|
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
2617
2624
|
*/
|
|
@@ -2619,6 +2626,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
2619
2626
|
repositoryId: string;
|
|
2620
2627
|
entryId: number;
|
|
2621
2628
|
request?: StartImportUploadedPartsRequest | undefined;
|
|
2629
|
+
autoCreateFolderPath?: boolean | undefined;
|
|
2622
2630
|
culture?: string | null | undefined;
|
|
2623
2631
|
}): Promise<StartTaskResponse>;
|
|
2624
2632
|
protected processStartImportUploadedParts(response: Response): Promise<StartTaskResponse>;
|
|
@@ -2729,6 +2737,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
2729
2737
|
- Required OAuth scope: repository.Write
|
|
2730
2738
|
* @param args.repositoryId The requested repository ID.
|
|
2731
2739
|
* @param args.entryId The entry ID of the folder that the document will be created in.
|
|
2740
|
+
* @param args.autoCreateFolderPath (optional) When true, any missing folders in the request's `folderPath` are created; when false (default), a missing folder returns 404.
|
|
2732
2741
|
* @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.
|
|
2733
2742
|
* @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.
|
|
2734
2743
|
* @param args.request (optional)
|
|
@@ -2738,6 +2747,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
2738
2747
|
importEntry(args: {
|
|
2739
2748
|
repositoryId: string;
|
|
2740
2749
|
entryId: number;
|
|
2750
|
+
autoCreateFolderPath?: boolean | undefined;
|
|
2741
2751
|
culture?: string | null | undefined;
|
|
2742
2752
|
file?: FileParameter | undefined;
|
|
2743
2753
|
request?: ImportEntryRequest | undefined;
|
|
@@ -2820,6 +2830,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
2820
2830
|
* @param args.repositoryId The requested repository ID.
|
|
2821
2831
|
* @param args.entryId The folder ID that the entry will be created in.
|
|
2822
2832
|
* @param args.request The request body.
|
|
2833
|
+
* @param args.autoCreateFolderPath (optional) When true, any missing folders in the request's `folderPath` are created; when false (default), a missing folder returns 404.
|
|
2823
2834
|
* @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.
|
|
2824
2835
|
* @returns Document was created successfully. Returns created entry.
|
|
2825
2836
|
*/
|
|
@@ -2827,6 +2838,7 @@ export declare class EntriesClient implements IEntriesClient {
|
|
|
2827
2838
|
repositoryId: string;
|
|
2828
2839
|
entryId: number;
|
|
2829
2840
|
request: CreateEntryRequest;
|
|
2841
|
+
autoCreateFolderPath?: boolean | undefined;
|
|
2830
2842
|
culture?: string | null | undefined;
|
|
2831
2843
|
}): Promise<Entry>;
|
|
2832
2844
|
protected processCreateEntry(response: Response): Promise<Entry>;
|
|
@@ -7220,6 +7232,11 @@ For any other file type (PDF, Word, Excel, etc.), the file is always imported as
|
|
|
7220
7232
|
metadata?: ImportEntryRequestMetadata | undefined;
|
|
7221
7233
|
/** The name of the volume to use. Will use the default parent entry volume if not specified. This is ignored in Laserfiche Cloud. */
|
|
7222
7234
|
volumeName?: string | undefined;
|
|
7235
|
+
/** An optional folder path, relative to the entry given in the route, that the document is imported into.
|
|
7236
|
+
Both `/` and `\` are accepted as separators. When any folder in this path does not exist, set the
|
|
7237
|
+
`autoCreateFolderPath` query parameter to true to create the missing folders; otherwise the request
|
|
7238
|
+
fails with 404. When omitted, the document is imported directly into the route entry (unchanged behavior). */
|
|
7239
|
+
folderPath?: string | undefined;
|
|
7223
7240
|
constructor(data?: IStartImportUploadedPartsRequest);
|
|
7224
7241
|
init(_data?: any): void;
|
|
7225
7242
|
static fromJS(data: any): StartImportUploadedPartsRequest;
|
|
@@ -7245,6 +7262,11 @@ For any other file type (PDF, Word, Excel, etc.), the file is always imported as
|
|
|
7245
7262
|
metadata?: ImportEntryRequestMetadata | undefined;
|
|
7246
7263
|
/** The name of the volume to use. Will use the default parent entry volume if not specified. This is ignored in Laserfiche Cloud. */
|
|
7247
7264
|
volumeName?: string | undefined;
|
|
7265
|
+
/** An optional folder path, relative to the entry given in the route, that the document is imported into.
|
|
7266
|
+
Both `/` and `\` are accepted as separators. When any folder in this path does not exist, set the
|
|
7267
|
+
`autoCreateFolderPath` query parameter to true to create the missing folders; otherwise the request
|
|
7268
|
+
fails with 404. When omitted, the document is imported directly into the route entry (unchanged behavior). */
|
|
7269
|
+
folderPath?: string | undefined;
|
|
7248
7270
|
}
|
|
7249
7271
|
/** 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. */
|
|
7250
7272
|
export declare class ImportEntryRequestPdfOptions implements IImportEntryRequestPdfOptions {
|
|
@@ -7873,6 +7895,11 @@ For any other file type (PDF, Word, Excel, etc.), the file is always imported as
|
|
|
7873
7895
|
/** Whether to generate searchable text (OCR) for image pages added via `imageFiles`. Default: true.
|
|
7874
7896
|
Does not affect pages generated from `file` — use `pdfOptions.generateText` for those. */
|
|
7875
7897
|
generateImagePagesText?: boolean;
|
|
7898
|
+
/** An optional folder path, relative to the entry given in the route, that the document is imported into.
|
|
7899
|
+
Both `/` and `\` are accepted as separators. When any folder in this path does not exist, set the
|
|
7900
|
+
`autoCreateFolderPath` query parameter to true to create the missing folders; otherwise the request
|
|
7901
|
+
fails with 404. When omitted, the document is imported directly into the route entry (unchanged behavior). */
|
|
7902
|
+
folderPath?: string | undefined;
|
|
7876
7903
|
constructor(data?: IImportEntryRequest);
|
|
7877
7904
|
init(_data?: any): void;
|
|
7878
7905
|
static fromJS(data: any): ImportEntryRequest;
|
|
@@ -7897,6 +7924,11 @@ For any other file type (PDF, Word, Excel, etc.), the file is always imported as
|
|
|
7897
7924
|
/** Whether to generate searchable text (OCR) for image pages added via `imageFiles`. Default: true.
|
|
7898
7925
|
Does not affect pages generated from `file` — use `pdfOptions.generateText` for those. */
|
|
7899
7926
|
generateImagePagesText?: boolean;
|
|
7927
|
+
/** An optional folder path, relative to the entry given in the route, that the document is imported into.
|
|
7928
|
+
Both `/` and `\` are accepted as separators. When any folder in this path does not exist, set the
|
|
7929
|
+
`autoCreateFolderPath` query parameter to true to create the missing folders; otherwise the request
|
|
7930
|
+
fails with 404. When omitted, the document is imported directly into the route entry (unchanged behavior). */
|
|
7931
|
+
folderPath?: string | undefined;
|
|
7900
7932
|
}
|
|
7901
7933
|
/** Response containing a link to download the exported entry. */
|
|
7902
7934
|
export declare class ExportEntryResponse implements IExportEntryResponse {
|
|
@@ -8284,6 +8316,11 @@ export declare class CreateEntryRequest implements ICreateEntryRequest {
|
|
|
8284
8316
|
targetId?: number;
|
|
8285
8317
|
/** The name of the volume to use. Will use the default parent entry volume if not specified. This is ignored in Laserfiche Cloud. */
|
|
8286
8318
|
volumeName?: string | undefined;
|
|
8319
|
+
/** An optional folder path, relative to the entry given in the route, that the new entry is created under.
|
|
8320
|
+
Both `/` and `\` are accepted as separators. When any folder in this path does not exist, set the
|
|
8321
|
+
`autoCreateFolderPath` query parameter to true to create the missing folders; otherwise the request
|
|
8322
|
+
fails with 404. When omitted, the entry is created directly under the route entry (unchanged behavior). */
|
|
8323
|
+
folderPath?: string | undefined;
|
|
8287
8324
|
constructor(data?: ICreateEntryRequest);
|
|
8288
8325
|
init(_data?: any): void;
|
|
8289
8326
|
static fromJS(data: any): CreateEntryRequest;
|
|
@@ -8301,6 +8338,11 @@ export interface ICreateEntryRequest {
|
|
|
8301
8338
|
targetId?: number;
|
|
8302
8339
|
/** The name of the volume to use. Will use the default parent entry volume if not specified. This is ignored in Laserfiche Cloud. */
|
|
8303
8340
|
volumeName?: string | undefined;
|
|
8341
|
+
/** An optional folder path, relative to the entry given in the route, that the new entry is created under.
|
|
8342
|
+
Both `/` and `\` are accepted as separators. When any folder in this path does not exist, set the
|
|
8343
|
+
`autoCreateFolderPath` query parameter to true to create the missing folders; otherwise the request
|
|
8344
|
+
fails with 404. When omitted, the entry is created directly under the route entry (unchanged behavior). */
|
|
8345
|
+
folderPath?: string | undefined;
|
|
8304
8346
|
}
|
|
8305
8347
|
/** Enumeration of entry types for CreateEntry. */
|
|
8306
8348
|
export declare enum CreateEntryRequestEntryType {
|
package/dist/index.js
CHANGED
|
@@ -21,7 +21,7 @@ export class AnnotationsClient {
|
|
|
21
21
|
constructor(baseUrl, http) {
|
|
22
22
|
this.jsonParseReviver = undefined;
|
|
23
23
|
this.http = http ? http : window;
|
|
24
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
24
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
25
25
|
}
|
|
26
26
|
/**
|
|
27
27
|
* - Returns every annotation on every page of the document, as a polymorphic list keyed by annotation type.
|
|
@@ -1380,7 +1380,7 @@ export class AttributesClient {
|
|
|
1380
1380
|
constructor(baseUrl, http) {
|
|
1381
1381
|
this.jsonParseReviver = undefined;
|
|
1382
1382
|
this.http = http ? http : window;
|
|
1383
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
1383
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
1384
1384
|
}
|
|
1385
1385
|
/**
|
|
1386
1386
|
* It will continue to make the same call to get a list of attributes key value pairs of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.
|
|
@@ -1665,7 +1665,7 @@ export class AuditReasonsClient {
|
|
|
1665
1665
|
constructor(baseUrl, http) {
|
|
1666
1666
|
this.jsonParseReviver = undefined;
|
|
1667
1667
|
this.http = http ? http : window;
|
|
1668
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
1668
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
1669
1669
|
}
|
|
1670
1670
|
/**
|
|
1671
1671
|
* - Returns the audit reasons associated with the authenticated user. Inherited audit reasons are included.
|
|
@@ -1791,7 +1791,7 @@ export class FieldDefinitionsClient {
|
|
|
1791
1791
|
constructor(baseUrl, http) {
|
|
1792
1792
|
this.jsonParseReviver = undefined;
|
|
1793
1793
|
this.http = http ? http : window;
|
|
1794
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
1794
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
1795
1795
|
}
|
|
1796
1796
|
/**
|
|
1797
1797
|
* It will continue to make the same call to get a list of field definitions of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.
|
|
@@ -3190,7 +3190,7 @@ export class AccessControlClient {
|
|
|
3190
3190
|
constructor(baseUrl, http) {
|
|
3191
3191
|
this.jsonParseReviver = undefined;
|
|
3192
3192
|
this.http = http ? http : window;
|
|
3193
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
3193
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
3194
3194
|
}
|
|
3195
3195
|
/**
|
|
3196
3196
|
* - Returns the field's access control entries (ACEs): the trustee, whether rights are allowed or denied, and the rights themselves. Field ACEs have no scope and are never inherited.
|
|
@@ -4779,7 +4779,7 @@ export class LinkDefinitionsClient {
|
|
|
4779
4779
|
constructor(baseUrl, http) {
|
|
4780
4780
|
this.jsonParseReviver = undefined;
|
|
4781
4781
|
this.http = http ? http : window;
|
|
4782
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
4782
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
4783
4783
|
}
|
|
4784
4784
|
/**
|
|
4785
4785
|
* It will continue to make the same call to get a list of link definitions of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.
|
|
@@ -5056,7 +5056,7 @@ export class EntriesClient {
|
|
|
5056
5056
|
constructor(baseUrl, http) {
|
|
5057
5057
|
this.jsonParseReviver = undefined;
|
|
5058
5058
|
this.http = http ? http : window;
|
|
5059
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
5059
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
5060
5060
|
}
|
|
5061
5061
|
/**
|
|
5062
5062
|
* It will continue to make the same call to get a list of entry listings of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.
|
|
@@ -5405,11 +5405,12 @@ export class EntriesClient {
|
|
|
5405
5405
|
* @param args.repositoryId The requested repository ID.
|
|
5406
5406
|
* @param args.entryId The entry ID of the folder that the document will be created in.
|
|
5407
5407
|
* @param args.request (optional) The request body.
|
|
5408
|
+
* @param args.autoCreateFolderPath (optional) When true, any missing folders in the request's `folderPath` are created; when false (default), a missing folder returns 404.
|
|
5408
5409
|
* @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.
|
|
5409
5410
|
* @returns Operation was started successfully. Returned a long operation task ID.
|
|
5410
5411
|
*/
|
|
5411
5412
|
startImportUploadedParts(args) {
|
|
5412
|
-
let { repositoryId, entryId, request, culture } = args;
|
|
5413
|
+
let { repositoryId, entryId, request, autoCreateFolderPath, culture } = args;
|
|
5413
5414
|
let url_ = this.baseUrl + "/v2/Repositories/{repositoryId}/Entries/{entryId}/Folder/ImportUploadedParts?";
|
|
5414
5415
|
if (repositoryId === undefined || repositoryId === null)
|
|
5415
5416
|
throw new Error("The parameter 'repositoryId' must be defined.");
|
|
@@ -5417,6 +5418,10 @@ export class EntriesClient {
|
|
|
5417
5418
|
if (entryId === undefined || entryId === null)
|
|
5418
5419
|
throw new Error("The parameter 'entryId' must be defined.");
|
|
5419
5420
|
url_ = url_.replace("{entryId}", encodeURIComponent("" + entryId));
|
|
5421
|
+
if (autoCreateFolderPath === null)
|
|
5422
|
+
throw new Error("The parameter 'autoCreateFolderPath' cannot be null.");
|
|
5423
|
+
else if (autoCreateFolderPath !== undefined)
|
|
5424
|
+
url_ += "autoCreateFolderPath=" + encodeURIComponent("" + autoCreateFolderPath) + "&";
|
|
5420
5425
|
if (culture !== undefined && culture !== null)
|
|
5421
5426
|
url_ += "culture=" + encodeURIComponent("" + culture) + "&";
|
|
5422
5427
|
url_ = url_.replace(/[?&]$/, "");
|
|
@@ -6109,6 +6114,7 @@ export class EntriesClient {
|
|
|
6109
6114
|
- Required OAuth scope: repository.Write
|
|
6110
6115
|
* @param args.repositoryId The requested repository ID.
|
|
6111
6116
|
* @param args.entryId The entry ID of the folder that the document will be created in.
|
|
6117
|
+
* @param args.autoCreateFolderPath (optional) When true, any missing folders in the request's `folderPath` are created; when false (default), a missing folder returns 404.
|
|
6112
6118
|
* @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.
|
|
6113
6119
|
* @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.
|
|
6114
6120
|
* @param args.request (optional)
|
|
@@ -6116,7 +6122,7 @@ export class EntriesClient {
|
|
|
6116
6122
|
* @returns Document was created successfully. Returns created entry.
|
|
6117
6123
|
*/
|
|
6118
6124
|
importEntry(args) {
|
|
6119
|
-
let { repositoryId, entryId, culture, file, request, imageFiles } = args;
|
|
6125
|
+
let { repositoryId, entryId, autoCreateFolderPath, culture, file, request, imageFiles } = args;
|
|
6120
6126
|
let url_ = this.baseUrl + "/v2/Repositories/{repositoryId}/Entries/{entryId}/Folder/Import?";
|
|
6121
6127
|
if (repositoryId === undefined || repositoryId === null)
|
|
6122
6128
|
throw new Error("The parameter 'repositoryId' must be defined.");
|
|
@@ -6124,6 +6130,10 @@ export class EntriesClient {
|
|
|
6124
6130
|
if (entryId === undefined || entryId === null)
|
|
6125
6131
|
throw new Error("The parameter 'entryId' must be defined.");
|
|
6126
6132
|
url_ = url_.replace("{entryId}", encodeURIComponent("" + entryId));
|
|
6133
|
+
if (autoCreateFolderPath === null)
|
|
6134
|
+
throw new Error("The parameter 'autoCreateFolderPath' cannot be null.");
|
|
6135
|
+
else if (autoCreateFolderPath !== undefined)
|
|
6136
|
+
url_ += "autoCreateFolderPath=" + encodeURIComponent("" + autoCreateFolderPath) + "&";
|
|
6127
6137
|
if (culture !== undefined && culture !== null)
|
|
6128
6138
|
url_ += "culture=" + encodeURIComponent("" + culture) + "&";
|
|
6129
6139
|
url_ = url_.replace(/[?&]$/, "");
|
|
@@ -6599,11 +6609,12 @@ export class EntriesClient {
|
|
|
6599
6609
|
* @param args.repositoryId The requested repository ID.
|
|
6600
6610
|
* @param args.entryId The folder ID that the entry will be created in.
|
|
6601
6611
|
* @param args.request The request body.
|
|
6612
|
+
* @param args.autoCreateFolderPath (optional) When true, any missing folders in the request's `folderPath` are created; when false (default), a missing folder returns 404.
|
|
6602
6613
|
* @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.
|
|
6603
6614
|
* @returns Document was created successfully. Returns created entry.
|
|
6604
6615
|
*/
|
|
6605
6616
|
createEntry(args) {
|
|
6606
|
-
let { repositoryId, entryId, request, culture } = args;
|
|
6617
|
+
let { repositoryId, entryId, request, autoCreateFolderPath, culture } = args;
|
|
6607
6618
|
let url_ = this.baseUrl + "/v2/Repositories/{repositoryId}/Entries/{entryId}/Folder/Children?";
|
|
6608
6619
|
if (repositoryId === undefined || repositoryId === null)
|
|
6609
6620
|
throw new Error("The parameter 'repositoryId' must be defined.");
|
|
@@ -6611,6 +6622,10 @@ export class EntriesClient {
|
|
|
6611
6622
|
if (entryId === undefined || entryId === null)
|
|
6612
6623
|
throw new Error("The parameter 'entryId' must be defined.");
|
|
6613
6624
|
url_ = url_.replace("{entryId}", encodeURIComponent("" + entryId));
|
|
6625
|
+
if (autoCreateFolderPath === null)
|
|
6626
|
+
throw new Error("The parameter 'autoCreateFolderPath' cannot be null.");
|
|
6627
|
+
else if (autoCreateFolderPath !== undefined)
|
|
6628
|
+
url_ += "autoCreateFolderPath=" + encodeURIComponent("" + autoCreateFolderPath) + "&";
|
|
6614
6629
|
if (culture !== undefined && culture !== null)
|
|
6615
6630
|
url_ += "culture=" + encodeURIComponent("" + culture) + "&";
|
|
6616
6631
|
url_ = url_.replace(/[?&]$/, "");
|
|
@@ -10313,7 +10328,7 @@ export class RecordsManagementClient {
|
|
|
10313
10328
|
constructor(baseUrl, http) {
|
|
10314
10329
|
this.jsonParseReviver = undefined;
|
|
10315
10330
|
this.http = http ? http : window;
|
|
10316
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
10331
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
10317
10332
|
}
|
|
10318
10333
|
/**
|
|
10319
10334
|
* @param args.select (optional) Limits the properties returned in the result.
|
|
@@ -11298,7 +11313,7 @@ export class RepositoriesClient {
|
|
|
11298
11313
|
constructor(baseUrl, http) {
|
|
11299
11314
|
this.jsonParseReviver = undefined;
|
|
11300
11315
|
this.http = http ? http : window;
|
|
11301
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
11316
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
11302
11317
|
}
|
|
11303
11318
|
/**
|
|
11304
11319
|
* Returns the repository resource list that current user has access to given the API server base URL. Only available in Laserfiche Self-Hosted.
|
|
@@ -11402,7 +11417,7 @@ export class SearchesClient {
|
|
|
11402
11417
|
constructor(baseUrl, http) {
|
|
11403
11418
|
this.jsonParseReviver = undefined;
|
|
11404
11419
|
this.http = http ? http : window;
|
|
11405
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
11420
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
11406
11421
|
}
|
|
11407
11422
|
/**
|
|
11408
11423
|
* It will continue to make the same call to get a list of search results of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.
|
|
@@ -11908,7 +11923,7 @@ export class SimpleSearchesClient {
|
|
|
11908
11923
|
constructor(baseUrl, http) {
|
|
11909
11924
|
this.jsonParseReviver = undefined;
|
|
11910
11925
|
this.http = http ? http : window;
|
|
11911
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
11926
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
11912
11927
|
}
|
|
11913
11928
|
/**
|
|
11914
11929
|
* - Runs a "simple" search operation on the repository.
|
|
@@ -12059,7 +12074,7 @@ export class StampsClient {
|
|
|
12059
12074
|
constructor(baseUrl, http) {
|
|
12060
12075
|
this.jsonParseReviver = undefined;
|
|
12061
12076
|
this.http = http ? http : window;
|
|
12062
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
12077
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
12063
12078
|
}
|
|
12064
12079
|
/**
|
|
12065
12080
|
* - Use `scope` to select public, personal, or all stamps. The image bytes are not included; fetch them from the stamp's Image sub-resource.
|
|
@@ -12665,7 +12680,7 @@ export class TagDefinitionsClient {
|
|
|
12665
12680
|
constructor(baseUrl, http) {
|
|
12666
12681
|
this.jsonParseReviver = undefined;
|
|
12667
12682
|
this.http = http ? http : window;
|
|
12668
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
12683
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
12669
12684
|
}
|
|
12670
12685
|
/**
|
|
12671
12686
|
* It will continue to make the same call to get a list of tag definitions of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.
|
|
@@ -12952,7 +12967,7 @@ export class TasksClient {
|
|
|
12952
12967
|
constructor(baseUrl, http) {
|
|
12953
12968
|
this.jsonParseReviver = undefined;
|
|
12954
12969
|
this.http = http ? http : window;
|
|
12955
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
12970
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
12956
12971
|
}
|
|
12957
12972
|
/**
|
|
12958
12973
|
* - Returns the status of a set of one or more tasks.
|
|
@@ -13266,7 +13281,7 @@ export class TemplateDefinitionsClient {
|
|
|
13266
13281
|
constructor(baseUrl, http) {
|
|
13267
13282
|
this.jsonParseReviver = undefined;
|
|
13268
13283
|
this.http = http ? http : window;
|
|
13269
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
13284
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
13270
13285
|
}
|
|
13271
13286
|
/**
|
|
13272
13287
|
* Given a maximum page size, it will continue to make the same call to get a list of template definitions of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.
|
|
@@ -14934,7 +14949,7 @@ export class UserAreasClient {
|
|
|
14934
14949
|
constructor(baseUrl, http) {
|
|
14935
14950
|
this.jsonParseReviver = undefined;
|
|
14936
14951
|
this.http = http ? http : window;
|
|
14937
|
-
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "
|
|
14952
|
+
this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : "https://api.laserfiche.com/repository";
|
|
14938
14953
|
}
|
|
14939
14954
|
/**
|
|
14940
14955
|
* - Returns the documents in the authenticated user's Recent Documents list, most-recently-accessed first.
|
|
@@ -19112,6 +19127,7 @@ export class StartImportUploadedPartsRequest {
|
|
|
19112
19127
|
this.importAsElectronicDocument = _data["importAsElectronicDocument"] !== undefined ? _data["importAsElectronicDocument"] : false;
|
|
19113
19128
|
this.metadata = _data["metadata"] ? ImportEntryRequestMetadata.fromJS(_data["metadata"]) : undefined;
|
|
19114
19129
|
this.volumeName = _data["volumeName"];
|
|
19130
|
+
this.folderPath = _data["folderPath"];
|
|
19115
19131
|
}
|
|
19116
19132
|
}
|
|
19117
19133
|
static fromJS(data) {
|
|
@@ -19134,6 +19150,7 @@ export class StartImportUploadedPartsRequest {
|
|
|
19134
19150
|
data["importAsElectronicDocument"] = this.importAsElectronicDocument;
|
|
19135
19151
|
data["metadata"] = this.metadata ? this.metadata.toJSON() : undefined;
|
|
19136
19152
|
data["volumeName"] = this.volumeName;
|
|
19153
|
+
data["folderPath"] = this.folderPath;
|
|
19137
19154
|
return data;
|
|
19138
19155
|
}
|
|
19139
19156
|
}
|
|
@@ -19942,6 +19959,7 @@ export class ImportEntryRequest {
|
|
|
19942
19959
|
this.metadata = _data["metadata"] ? ImportEntryRequestMetadata.fromJS(_data["metadata"]) : undefined;
|
|
19943
19960
|
this.volumeName = _data["volumeName"];
|
|
19944
19961
|
this.generateImagePagesText = _data["generateImagePagesText"] !== undefined ? _data["generateImagePagesText"] : true;
|
|
19962
|
+
this.folderPath = _data["folderPath"];
|
|
19945
19963
|
}
|
|
19946
19964
|
}
|
|
19947
19965
|
static fromJS(data) {
|
|
@@ -19959,6 +19977,7 @@ export class ImportEntryRequest {
|
|
|
19959
19977
|
data["metadata"] = this.metadata ? this.metadata.toJSON() : undefined;
|
|
19960
19978
|
data["volumeName"] = this.volumeName;
|
|
19961
19979
|
data["generateImagePagesText"] = this.generateImagePagesText;
|
|
19980
|
+
data["folderPath"] = this.folderPath;
|
|
19962
19981
|
return data;
|
|
19963
19982
|
}
|
|
19964
19983
|
}
|
|
@@ -20544,6 +20563,7 @@ export class CreateEntryRequest {
|
|
|
20544
20563
|
this.entryType = _data["entryType"];
|
|
20545
20564
|
this.targetId = _data["targetId"];
|
|
20546
20565
|
this.volumeName = _data["volumeName"];
|
|
20566
|
+
this.folderPath = _data["folderPath"];
|
|
20547
20567
|
}
|
|
20548
20568
|
}
|
|
20549
20569
|
static fromJS(data) {
|
|
@@ -20559,6 +20579,7 @@ export class CreateEntryRequest {
|
|
|
20559
20579
|
data["entryType"] = this.entryType;
|
|
20560
20580
|
data["targetId"] = this.targetId;
|
|
20561
20581
|
data["volumeName"] = this.volumeName;
|
|
20582
|
+
data["folderPath"] = this.folderPath;
|
|
20562
20583
|
return data;
|
|
20563
20584
|
}
|
|
20564
20585
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@laserfiche/lf-repository-api-client-v2",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.4.0",
|
|
5
5
|
"description": "The TypeScript Laserfiche Repository API Client library for accessing the v2 Laserfiche Repository APIs.",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
7
|
"types": "dist/index.d.ts",
|