@korala/api-client 1.16.0 → 1.18.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/README.md +24 -0
- package/dist/client.d.ts +2 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +3 -0
- package/dist/query.d.ts +2 -0
- package/dist/query.d.ts.map +1 -0
- package/dist/query.js +11 -0
- package/dist/resources/collections.d.ts +20 -0
- package/dist/resources/collections.d.ts.map +1 -0
- package/dist/resources/collections.js +54 -0
- package/dist/resources/documents.d.ts +3 -1
- package/dist/resources/documents.d.ts.map +1 -1
- package/dist/resources/documents.js +7 -2
- package/dist/resources/signing-packets.d.ts +3 -0
- package/dist/resources/signing-packets.d.ts.map +1 -1
- package/dist/resources/signing-packets.js +6 -0
- package/dist/resources/templates.d.ts +3 -7
- package/dist/resources/templates.d.ts.map +1 -1
- package/dist/resources/templates.js +6 -12
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -145,3 +145,27 @@ const webhook = await client.webhooks.create({
|
|
|
145
145
|
## License
|
|
146
146
|
|
|
147
147
|
MIT
|
|
148
|
+
|
|
149
|
+
## Collections
|
|
150
|
+
|
|
151
|
+
Use collections to group documents and templates within your organization
|
|
152
|
+
and mode. Supply `collectionIds` when creating a resource. Choose destinations
|
|
153
|
+
for each generated document; template memberships do not carry over. The public exports include collection, membership,
|
|
154
|
+
pagination, and query types. See the [collections guide](https://docs.korala.ai/guides/collections)
|
|
155
|
+
for limits and the full workflow.
|
|
156
|
+
|
|
157
|
+
```typescript
|
|
158
|
+
const collection = await client.collections.create({
|
|
159
|
+
name: 'Acme', externalId: 'crm:acme',
|
|
160
|
+
});
|
|
161
|
+
await client.collections.addDocuments(collection.id, [documentId]);
|
|
162
|
+
const page = await client.documents.listPage({ collectionId: collection.id });
|
|
163
|
+
const combined = await client.documents.listPage({
|
|
164
|
+
collectionIds: [collection.id, anotherCollection.id],
|
|
165
|
+
}); // Documents in either collection, without duplicates.
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
`documents.listPage()` returns the pagination envelope. Deprecated
|
|
169
|
+
`documents.list()` returns only the first page’s items, matching its array
|
|
170
|
+
contract; earlier releases incorrectly returned the envelope at runtime.
|
|
171
|
+
`templates.list()` continues returning an envelope; `listPage()` is an alias.
|
package/dist/client.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { CatalogResource } from './resources/catalog.js';
|
|
2
|
+
import { CollectionsResource } from './resources/collections.js';
|
|
2
3
|
import { DocumentsResource } from './resources/documents.js';
|
|
3
4
|
import { FieldsResource } from './resources/fields.js';
|
|
4
5
|
import { SessionsResource } from './resources/sessions.js';
|
|
@@ -15,6 +16,7 @@ export interface KoralaClientConfig {
|
|
|
15
16
|
timeout?: number;
|
|
16
17
|
}
|
|
17
18
|
export declare class KoralaClient {
|
|
19
|
+
readonly collections: CollectionsResource;
|
|
18
20
|
readonly catalog: CatalogResource;
|
|
19
21
|
readonly documents: DocumentsResource;
|
|
20
22
|
readonly signers: SignersResource;
|
package/dist/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAKD,qBAAa,YAAY;IACvB,SAAgB,OAAO,EAAE,eAAe,CAAC;IACzC,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,OAAO,EAAE,eAAe,CAAC;IACzC,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,SAAgB,UAAU,EAAE,kBAAkB,CAAC;IAC/C,SAAgB,cAAc,EAAE,sBAAsB,CAAC;IACvD,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAC3C,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAE3C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;gBAEtB,MAAM,EAAE,kBAAkB;
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAKD,qBAAa,YAAY;IACvB,SAAgB,WAAW,EAAE,mBAAmB,CAAC;IACjD,SAAgB,OAAO,EAAE,eAAe,CAAC;IACzC,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,OAAO,EAAE,eAAe,CAAC;IACzC,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,SAAgB,UAAU,EAAE,kBAAkB,CAAC;IAC/C,SAAgB,cAAc,EAAE,sBAAsB,CAAC;IACvD,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAC3C,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAE3C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;gBAEtB,MAAM,EAAE,kBAAkB;CAoBvC"}
|
package/dist/client.js
CHANGED
|
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.KoralaClient = void 0;
|
|
4
4
|
const http_js_1 = require("./http.js");
|
|
5
5
|
const catalog_js_1 = require("./resources/catalog.js");
|
|
6
|
+
const collections_js_1 = require("./resources/collections.js");
|
|
6
7
|
const documents_js_1 = require("./resources/documents.js");
|
|
7
8
|
const fields_js_1 = require("./resources/fields.js");
|
|
8
9
|
const sessions_js_1 = require("./resources/sessions.js");
|
|
@@ -15,6 +16,7 @@ const workflows_js_1 = require("./resources/workflows.js");
|
|
|
15
16
|
const DEFAULT_BASE_URL = 'https://api.korala.ai/api/v1';
|
|
16
17
|
const DEFAULT_TIMEOUT = 30000;
|
|
17
18
|
class KoralaClient {
|
|
19
|
+
collections;
|
|
18
20
|
catalog;
|
|
19
21
|
documents;
|
|
20
22
|
signers;
|
|
@@ -33,6 +35,7 @@ class KoralaClient {
|
|
|
33
35
|
baseUrl: config.baseUrl ?? DEFAULT_BASE_URL,
|
|
34
36
|
timeout: config.timeout ?? DEFAULT_TIMEOUT,
|
|
35
37
|
});
|
|
38
|
+
this.collections = new collections_js_1.CollectionsResource(this.http);
|
|
36
39
|
this.catalog = new catalog_js_1.CatalogResource(this.http);
|
|
37
40
|
this.documents = new documents_js_1.DocumentsResource(this.http);
|
|
38
41
|
this.signers = new signers_js_1.SignersResource(this.http);
|
package/dist/query.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,CAAC,OAAO,GAAE,MAAW,GAAG,MAAM,CAMxD"}
|
package/dist/query.js
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.queryString = queryString;
|
|
4
|
+
function queryString(options = {}) {
|
|
5
|
+
const query = new URLSearchParams();
|
|
6
|
+
for (const [key, value] of Object.entries(options)) {
|
|
7
|
+
if (value !== undefined && value !== null)
|
|
8
|
+
query.set(key, String(value));
|
|
9
|
+
}
|
|
10
|
+
return query.size ? `?${query}` : '';
|
|
11
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { CollectionDto, CollectionsControllerListDocumentsV1Params, CollectionsControllerListTemplatesV1Params, CollectionsControllerListV1Params, CreateCollectionDto, PaginatedCollectionsDto, PaginatedDocumentsDto, PaginatedTemplatesDto, UpdateCollectionDto } from '@korala/public-dtos';
|
|
2
|
+
import type { HttpClient } from '../http.js';
|
|
3
|
+
export declare class CollectionsResource {
|
|
4
|
+
private readonly http;
|
|
5
|
+
constructor(http: HttpClient);
|
|
6
|
+
create(data: CreateCollectionDto): Promise<CollectionDto>;
|
|
7
|
+
list(query?: CollectionsControllerListV1Params): Promise<PaginatedCollectionsDto>;
|
|
8
|
+
get(id: string): Promise<CollectionDto>;
|
|
9
|
+
byExternalId(externalId: string): Promise<CollectionDto>;
|
|
10
|
+
update(id: string, data: UpdateCollectionDto): Promise<CollectionDto>;
|
|
11
|
+
archive(id: string): Promise<CollectionDto>;
|
|
12
|
+
restore(id: string): Promise<CollectionDto>;
|
|
13
|
+
listDocuments(id: string, query?: Omit<CollectionsControllerListDocumentsV1Params, 'id'>): Promise<PaginatedDocumentsDto>;
|
|
14
|
+
listTemplates(id: string, query?: Omit<CollectionsControllerListTemplatesV1Params, 'id'>): Promise<PaginatedTemplatesDto>;
|
|
15
|
+
addDocuments(id: string, documentIds: string[]): Promise<void>;
|
|
16
|
+
removeDocuments(id: string, documentIds: string[]): Promise<void>;
|
|
17
|
+
addTemplates(id: string, templateIds: string[]): Promise<void>;
|
|
18
|
+
removeTemplates(id: string, templateIds: string[]): Promise<void>;
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=collections.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"collections.d.ts","sourceRoot":"","sources":["../../src/resources/collections.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,0CAA0C,EAC1C,0CAA0C,EAC1C,iCAAiC,EACjC,mBAAmB,EACnB,uBAAuB,EACvB,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7C,qBAAa,mBAAmB;IAClB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAC7C,MAAM,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC;IAGzD,IAAI,CACF,KAAK,GAAE,iCAAsC,GAC5C,OAAO,CAAC,uBAAuB,CAAC;IAGnC,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAGvC,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAKxD,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC;IAGrE,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAG3C,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAG3C,aAAa,CACX,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,IAAI,CAAC,0CAA0C,EAAE,IAAI,CAAM,GACjE,OAAO,CAAC,qBAAqB,CAAC;IAGjC,aAAa,CACX,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,IAAI,CAAC,0CAA0C,EAAE,IAAI,CAAM,GACjE,OAAO,CAAC,qBAAqB,CAAC;IAGjC,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAG9D,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAKjE,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAG9D,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAKlE"}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.CollectionsResource = void 0;
|
|
4
|
+
const query_js_1 = require("../query.js");
|
|
5
|
+
class CollectionsResource {
|
|
6
|
+
http;
|
|
7
|
+
constructor(http) {
|
|
8
|
+
this.http = http;
|
|
9
|
+
}
|
|
10
|
+
create(data) {
|
|
11
|
+
return this.http.post('/collections', data);
|
|
12
|
+
}
|
|
13
|
+
list(query = {}) {
|
|
14
|
+
return this.http.get(`/collections${(0, query_js_1.queryString)(query)}`);
|
|
15
|
+
}
|
|
16
|
+
get(id) {
|
|
17
|
+
return this.http.get(`/collections/${id}`);
|
|
18
|
+
}
|
|
19
|
+
byExternalId(externalId) {
|
|
20
|
+
return this.http.get(`/collections/by-external-id${(0, query_js_1.queryString)({ externalId })}`);
|
|
21
|
+
}
|
|
22
|
+
update(id, data) {
|
|
23
|
+
return this.http.patch(`/collections/${id}`, data);
|
|
24
|
+
}
|
|
25
|
+
archive(id) {
|
|
26
|
+
return this.http.post(`/collections/${id}/archive`);
|
|
27
|
+
}
|
|
28
|
+
restore(id) {
|
|
29
|
+
return this.http.post(`/collections/${id}/restore`);
|
|
30
|
+
}
|
|
31
|
+
listDocuments(id, query = {}) {
|
|
32
|
+
return this.http.get(`/collections/${id}/documents${(0, query_js_1.queryString)(query)}`);
|
|
33
|
+
}
|
|
34
|
+
listTemplates(id, query = {}) {
|
|
35
|
+
return this.http.get(`/collections/${id}/templates${(0, query_js_1.queryString)(query)}`);
|
|
36
|
+
}
|
|
37
|
+
addDocuments(id, documentIds) {
|
|
38
|
+
return this.http.post(`/collections/${id}/documents/add`, { documentIds });
|
|
39
|
+
}
|
|
40
|
+
removeDocuments(id, documentIds) {
|
|
41
|
+
return this.http.post(`/collections/${id}/documents/remove`, {
|
|
42
|
+
documentIds,
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
addTemplates(id, templateIds) {
|
|
46
|
+
return this.http.post(`/collections/${id}/templates/add`, { templateIds });
|
|
47
|
+
}
|
|
48
|
+
removeTemplates(id, templateIds) {
|
|
49
|
+
return this.http.post(`/collections/${id}/templates/remove`, {
|
|
50
|
+
templateIds,
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
exports.CollectionsResource = CollectionsResource;
|
|
@@ -1,11 +1,13 @@
|
|
|
1
|
-
import type { AcroFormFieldDto, AssignFormFieldPartiesDto, AuditEventDto, BulkSignRequestDto, BulkSignResponseDto, ConfirmUploadDto, CreateUploadUrlDto, DocumentDto, FieldDto, FormFieldPartyDto, ImportFormFieldsDto, UploadUrlResponseDto } from '@korala/public-dtos';
|
|
1
|
+
import type { AcroFormFieldDto, AssignFormFieldPartiesDto, AuditEventDto, BulkSignRequestDto, BulkSignResponseDto, ConfirmUploadDto, CreateUploadUrlDto, DocumentDto, DocumentsControllerFindAllV1Params, FieldDto, FormFieldPartyDto, ImportFormFieldsDto, PaginatedDocumentsDto, UploadUrlResponseDto } from '@korala/public-dtos';
|
|
2
2
|
import type { HttpClient } from '../http.js';
|
|
3
3
|
export declare class DocumentsResource {
|
|
4
4
|
private readonly http;
|
|
5
5
|
constructor(http: HttpClient);
|
|
6
6
|
createUploadUrl(data: CreateUploadUrlDto): Promise<UploadUrlResponseDto>;
|
|
7
7
|
confirmUpload(documentId: string, data?: ConfirmUploadDto): Promise<DocumentDto>;
|
|
8
|
+
/** @deprecated Use listPage(query) for pagination. Returns the first page only. */
|
|
8
9
|
list(): Promise<DocumentDto[]>;
|
|
10
|
+
listPage(query?: DocumentsControllerFindAllV1Params): Promise<PaginatedDocumentsDto>;
|
|
9
11
|
get(documentId: string): Promise<DocumentDto>;
|
|
10
12
|
send(documentId: string, options?: {
|
|
11
13
|
suppressNotifications?: boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../src/resources/documents.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,WAAW,EACX,QAAQ,EACR,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../src/resources/documents.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,WAAW,EACX,kCAAkC,EAClC,QAAQ,EACR,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7C,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,eAAe,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIxE,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,CAAC,EAAE,gBAAgB,GACtB,OAAO,CAAC,WAAW,CAAC;IAOvB,mFAAmF;IAC7E,IAAI,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAIpC,QAAQ,CACN,KAAK,GAAE,kCAAuC,GAC7C,OAAO,CAAC,qBAAqB,CAAC;IAIjC,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAI7C,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QAAE,qBAAqB,CAAC,EAAE,OAAO,CAAA;KAAE,GAC5C,OAAO,CAAC,WAAW,CAAC;IAOvB,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9C,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAM3D;;;OAGG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAM9D;;;;;;OAMG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,mBAAmB,GACxB,OAAO,CAAC,QAAQ,EAAE,CAAC;IAOtB;;;;;;;;OAQG;IACH,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAMrE,6DAA6D;IAC7D,sBAAsB,CACpB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,yBAAyB,GAC9B,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAO/B,QAAQ,CACN,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAC9B,OAAO,CAAC,mBAAmB,CAAC;CAUhC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.DocumentsResource = void 0;
|
|
4
|
+
const query_js_1 = require("../query.js");
|
|
4
5
|
class DocumentsResource {
|
|
5
6
|
http;
|
|
6
7
|
constructor(http) {
|
|
@@ -12,8 +13,12 @@ class DocumentsResource {
|
|
|
12
13
|
confirmUpload(documentId, data) {
|
|
13
14
|
return this.http.post(`/documents/${documentId}/confirm`, data);
|
|
14
15
|
}
|
|
15
|
-
|
|
16
|
-
|
|
16
|
+
/** @deprecated Use listPage(query) for pagination. Returns the first page only. */
|
|
17
|
+
async list() {
|
|
18
|
+
return (await this.listPage()).data;
|
|
19
|
+
}
|
|
20
|
+
listPage(query = {}) {
|
|
21
|
+
return this.http.get(`/documents${(0, query_js_1.queryString)(query)}`);
|
|
17
22
|
}
|
|
18
23
|
get(documentId) {
|
|
19
24
|
return this.http.get(`/documents/${documentId}`);
|
|
@@ -6,12 +6,15 @@ export declare class SigningPacketsResource {
|
|
|
6
6
|
create(data: CreateSigningPacketDto): Promise<SigningPacketDto>;
|
|
7
7
|
get(id: string): Promise<SigningPacketDto>;
|
|
8
8
|
list(options?: {
|
|
9
|
+
sourceCollectionId?: string;
|
|
9
10
|
status?: SigningPacketDto['status'];
|
|
10
11
|
search?: string;
|
|
11
12
|
page?: number;
|
|
12
13
|
limit?: number;
|
|
13
14
|
}): Promise<PaginatedSigningPacketsDto>;
|
|
14
15
|
listEligibleDocuments(options?: {
|
|
16
|
+
collectionId?: string;
|
|
17
|
+
documentIds?: string[];
|
|
15
18
|
search?: string;
|
|
16
19
|
recipientEmail?: string;
|
|
17
20
|
sandbox?: boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"signing-packets.d.ts","sourceRoot":"","sources":["../../src/resources/signing-packets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,sBAAsB,EACtB,mCAAmC,EACnC,0BAA0B,EAC1B,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,qBAAa,sBAAsB;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,MAAM,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI/D,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI1C,IAAI,CACF,OAAO,GAAE;QACP,MAAM,CAAC,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KACX,GACL,OAAO,CAAC,0BAA0B,CAAC;
|
|
1
|
+
{"version":3,"file":"signing-packets.d.ts","sourceRoot":"","sources":["../../src/resources/signing-packets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,sBAAsB,EACtB,mCAAmC,EACnC,0BAA0B,EAC1B,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,qBAAa,sBAAsB;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,MAAM,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI/D,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI1C,IAAI,CACF,OAAO,GAAE;QACP,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,MAAM,CAAC,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KACX,GACL,OAAO,CAAC,0BAA0B,CAAC;IActC,qBAAqB,CACnB,OAAO,GAAE;QACP,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KACX,GACL,OAAO,CAAC,mCAAmC,CAAC;IAkB/C,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI3E,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,GAAE,oBAAyB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAO5E,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI7C,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAI/C,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAGlD"}
|
|
@@ -14,6 +14,8 @@ class SigningPacketsResource {
|
|
|
14
14
|
}
|
|
15
15
|
list(options = {}) {
|
|
16
16
|
const query = new URLSearchParams();
|
|
17
|
+
if (options.sourceCollectionId)
|
|
18
|
+
query.set('sourceCollectionId', options.sourceCollectionId);
|
|
17
19
|
if (options.status)
|
|
18
20
|
query.set('status', options.status);
|
|
19
21
|
if (options.search)
|
|
@@ -27,6 +29,10 @@ class SigningPacketsResource {
|
|
|
27
29
|
}
|
|
28
30
|
listEligibleDocuments(options = {}) {
|
|
29
31
|
const query = new URLSearchParams();
|
|
32
|
+
if (options.documentIds)
|
|
33
|
+
query.set('documentIds', options.documentIds.join(','));
|
|
34
|
+
if (options.collectionId)
|
|
35
|
+
query.set('collectionId', options.collectionId);
|
|
30
36
|
if (options.search)
|
|
31
37
|
query.set('search', options.search);
|
|
32
38
|
if (options.recipientEmail)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AcroFormFieldDto, AssignTemplateFormFieldPartiesDto, ConfirmReplaceTemplateFileDto, CreateDocumentFromTemplateDto, CreateSignerRoleDto, CreateTemplateDto, CreateTemplateFieldDto, CreateTemplateUploadUrlDto, DetectedMergeFieldDto, DocumentDto, DuplicateTemplateDto, GenerateDocumentDto, GeneratedDocumentDto, ImportTemplateFormFieldsDto, PaginatedTemplatesDto, ReplaceTemplateFileDto, ReplaceTemplateFileResponseDto, TemplateBookmarksDto, TemplateDto, TemplateFieldDto, TemplateFormFieldPartyDto, TemplateSignerRoleDto, TemplateUploadUrlResponseDto, TemplateWithDetailsDto, UpdateSignerRoleDto, UpdateTemplateDto, UpdateTemplateFieldDto } from '@korala/public-dtos';
|
|
1
|
+
import type { AcroFormFieldDto, AssignTemplateFormFieldPartiesDto, ConfirmReplaceTemplateFileDto, CreateDocumentFromTemplateDto, CreateSignerRoleDto, CreateTemplateDto, CreateTemplateFieldDto, CreateTemplateUploadUrlDto, DetectedMergeFieldDto, DocumentDto, DuplicateTemplateDto, GenerateDocumentDto, GeneratedDocumentDto, ImportTemplateFormFieldsDto, PaginatedTemplatesDto, ReplaceTemplateFileDto, ReplaceTemplateFileResponseDto, TemplateBookmarksDto, TemplateDto, TemplateFieldDto, TemplateFormFieldPartyDto, TemplateSignerRoleDto, TemplatesControllerFindAllV1Params, TemplateUploadUrlResponseDto, TemplateWithDetailsDto, UpdateSignerRoleDto, UpdateTemplateDto, UpdateTemplateFieldDto } from '@korala/public-dtos';
|
|
2
2
|
import type { HttpClient } from '../http.js';
|
|
3
3
|
export declare class TemplatesResource {
|
|
4
4
|
private readonly http;
|
|
@@ -7,12 +7,8 @@ export declare class TemplatesResource {
|
|
|
7
7
|
confirmUpload(templateId: string, data: CreateTemplateDto): Promise<TemplateDto>;
|
|
8
8
|
replaceFile(templateId: string, data: ReplaceTemplateFileDto): Promise<ReplaceTemplateFileResponseDto>;
|
|
9
9
|
confirmReplaceFile(templateId: string, data: ConfirmReplaceTemplateFileDto): Promise<TemplateDto>;
|
|
10
|
-
list(params?:
|
|
11
|
-
|
|
12
|
-
limit?: number;
|
|
13
|
-
sandbox?: boolean;
|
|
14
|
-
search?: string;
|
|
15
|
-
}): Promise<PaginatedTemplatesDto>;
|
|
10
|
+
list(params?: TemplatesControllerFindAllV1Params): Promise<PaginatedTemplatesDto>;
|
|
11
|
+
listPage(params?: TemplatesControllerFindAllV1Params): Promise<PaginatedTemplatesDto>;
|
|
16
12
|
get(templateId: string): Promise<TemplateWithDetailsDto>;
|
|
17
13
|
duplicate(templateId: string, data?: DuplicateTemplateDto): Promise<TemplateDto>;
|
|
18
14
|
update(templateId: string, data: UpdateTemplateDto): Promise<TemplateDto>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/resources/templates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,iCAAiC,EACjC,6BAA6B,EAC7B,6BAA6B,EAC7B,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,EACrB,WAAW,EACX,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,8BAA8B,EAC9B,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EAChB,yBAAyB,EACzB,qBAAqB,EACrB,4BAA4B,EAC5B,sBAAsB,EACtB,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/resources/templates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,iCAAiC,EACjC,6BAA6B,EAC7B,6BAA6B,EAC7B,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,EACrB,WAAW,EACX,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,8BAA8B,EAC9B,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EAChB,yBAAyB,EACzB,qBAAqB,EACrB,kCAAkC,EAClC,4BAA4B,EAC5B,sBAAsB,EACtB,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAG7C,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAI7C,eAAe,CACb,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,4BAA4B,CAAC;IAOxC,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,iBAAiB,GACtB,OAAO,CAAC,WAAW,CAAC;IAOvB,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,8BAA8B,CAAC;IAO1C,kBAAkB,CAChB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,6BAA6B,GAClC,OAAO,CAAC,WAAW,CAAC;IAOvB,IAAI,CACF,MAAM,GAAE,kCAAuC,GAC9C,OAAO,CAAC,qBAAqB,CAAC;IAIjC,QAAQ,CACN,MAAM,GAAE,kCAAuC,GAC9C,OAAO,CAAC,qBAAqB,CAAC;IAIjC,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAIxD,SAAS,CACP,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,oBAAyB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAOvB,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;IAIzE,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMzC,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,mBAAmB,GACxB,OAAO,CAAC,qBAAqB,CAAC;IAOjC,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAMpE,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,mBAAmB,GACxB,OAAO,CAAC,qBAAqB,CAAC;IAOjC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMnE,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,gBAAgB,CAAC;IAO5B,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAI1D,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,gBAAgB,CAAC;IAO5B,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/D;;;OAGG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAM9D;;;;;OAKG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,2BAAgC,GACrC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAO9B;;;OAGG;IACH,mBAAmB,CACjB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,yBAAyB,EAAE,CAAC;IAMvC,mEAAmE;IACnE,sBAAsB,CACpB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,iCAAiC,GACtC,OAAO,CAAC,yBAAyB,EAAE,CAAC;IAOvC;;;;;;;;OAQG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQ/D,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAQpE,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,6BAA6B,GAClC,OAAO,CAAC,WAAW,CAAC;IASvB,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,mBAAwB,GAC7B,OAAO,CAAC,oBAAoB,CAAC;CAMjC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.TemplatesResource = void 0;
|
|
4
|
+
const query_js_1 = require("../query.js");
|
|
4
5
|
class TemplatesResource {
|
|
5
6
|
http;
|
|
6
7
|
constructor(http) {
|
|
@@ -19,18 +20,11 @@ class TemplatesResource {
|
|
|
19
20
|
confirmReplaceFile(templateId, data) {
|
|
20
21
|
return this.http.post(`/templates/${templateId}/confirm-replace`, data);
|
|
21
22
|
}
|
|
22
|
-
list(params) {
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
query.set('limit', String(params.limit));
|
|
28
|
-
if (params?.sandbox !== undefined)
|
|
29
|
-
query.set('sandbox', String(params.sandbox));
|
|
30
|
-
if (params?.search)
|
|
31
|
-
query.set('search', params.search);
|
|
32
|
-
const qs = query.toString();
|
|
33
|
-
return this.http.get(`/templates${qs ? `?${qs}` : ''}`);
|
|
23
|
+
list(params = {}) {
|
|
24
|
+
return this.http.get(`/templates${(0, query_js_1.queryString)(params)}`);
|
|
25
|
+
}
|
|
26
|
+
listPage(params = {}) {
|
|
27
|
+
return this.list(params);
|
|
34
28
|
}
|
|
35
29
|
get(templateId) {
|
|
36
30
|
return this.http.get(`/templates/${templateId}`);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@korala/api-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.18.0",
|
|
4
4
|
"description": "TypeScript API client for Korala document signing API",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://docs.korala.ai",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
],
|
|
31
31
|
"dependencies": {
|
|
32
32
|
"@korala/auth": "^1.1.0",
|
|
33
|
-
"@korala/public-dtos": "^1.
|
|
33
|
+
"@korala/public-dtos": "^1.18.0"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
36
|
"typescript": "^5.9.3"
|