@ptkl/sdk 0.9.15 → 0.10.1
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.cjs.js +302 -42
- package/dist/index.esm.js +302 -42
- package/dist/index.iife.js +303 -43
- package/dist/monaco.d.ts +341 -13
- package/dist/package.json +1 -1
- package/dist/types/api/integrations/dms.d.ts +60 -20
- package/dist/types/api/ratchet.d.ts +193 -1
- package/dist/types/index.d.ts +1 -0
- package/dist/types/types/integrations.d.ts +59 -1
- package/dist/types/types/ratchet.d.ts +38 -0
- package/package.json +1 -1
package/dist/monaco.d.ts
CHANGED
|
@@ -8,7 +8,6 @@ export { default as System } from './api/system';
|
|
|
8
8
|
export { default as User } from './api/users';
|
|
9
9
|
export { default as Functions } from './api/functions';
|
|
10
10
|
export { default as APIUser } from './api/apiUser';
|
|
11
|
-
export { default as Roles } from './api/roles';
|
|
12
11
|
export { default as Apps } from './api/apps';
|
|
13
12
|
export { default as Workflow } from './api/workflow';
|
|
14
13
|
export { default as ComponentUtils } from './api/componentUtils';
|
|
@@ -20,9 +19,13 @@ export { default as Invoicing } from './api/integrations/invoicing';
|
|
|
20
19
|
export { default as DMS } from './api/integrations/dms';
|
|
21
20
|
export { default as SerbiaUtil } from './api/integrations/serbiaUtil';
|
|
22
21
|
export { default as VPFR } from './api/integrations/vpfr';
|
|
22
|
+
export { default as Project } from './api/project';
|
|
23
|
+
export { default as Config } from './api/config';
|
|
23
24
|
export type * from './types/component';
|
|
24
25
|
export type * from './types/integrations';
|
|
25
26
|
export type * from './types/users';
|
|
27
|
+
export type * from './types/project';
|
|
28
|
+
export type * from './types/config';
|
|
26
29
|
export default Platform;
|
|
27
30
|
|
|
28
31
|
}
|
|
@@ -85,6 +88,19 @@ declare type ModifyOptions = {
|
|
|
85
88
|
upsert: boolean;
|
|
86
89
|
};
|
|
87
90
|
|
|
91
|
+
declare interface UserConfig {
|
|
92
|
+
uuid?: string;
|
|
93
|
+
user_uuid: string;
|
|
94
|
+
data: Record<string, any>;
|
|
95
|
+
created_at?: string;
|
|
96
|
+
updated_at?: string;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
declare interface ConfigUpdateRequest {
|
|
100
|
+
data: Record<string, any>;
|
|
101
|
+
path: string;
|
|
102
|
+
}
|
|
103
|
+
|
|
88
104
|
declare type PaymentProvider = 'monri';
|
|
89
105
|
|
|
90
106
|
declare type GetPaymentLinkOptions = {
|
|
@@ -183,6 +199,8 @@ declare type DataConversionParams = {
|
|
|
183
199
|
footer_as_comment?: boolean;
|
|
184
200
|
/** Empty rows between sections (default: 1) */
|
|
185
201
|
separator_rows?: number;
|
|
202
|
+
/** Specify order of fields/columns */
|
|
203
|
+
field_order?: string[];
|
|
186
204
|
};
|
|
187
205
|
|
|
188
206
|
/**
|
|
@@ -236,9 +254,213 @@ declare type DataValidationResult = {
|
|
|
236
254
|
*/
|
|
237
255
|
declare type ConversionOptions = {
|
|
238
256
|
/** Excel sheet name for read/write operations (defaults to "Sheet1") */
|
|
239
|
-
sheet_name?: string;
|
|
257
|
+
sheet_name?: string; /** Specify order of fields/columns */
|
|
258
|
+
field_order?: string[];
|
|
259
|
+
};
|
|
260
|
+
|
|
261
|
+
declare type NbsIpsQrCode = {
|
|
262
|
+
TransactionType: string;
|
|
263
|
+
Version: string;
|
|
264
|
+
CharacterSet: string;
|
|
265
|
+
RecipientAccountNumber: string;
|
|
266
|
+
RecipientName: string;
|
|
267
|
+
AmountInLocalCurrency: string;
|
|
268
|
+
PayerInformation: string;
|
|
269
|
+
PaymentPurposeCode: string;
|
|
270
|
+
PurposeOfPayment: string;
|
|
271
|
+
PaymentOrderNumber: string;
|
|
240
272
|
};
|
|
241
273
|
|
|
274
|
+
declare interface MediaLibrary {
|
|
275
|
+
uuid: string;
|
|
276
|
+
ref: string;
|
|
277
|
+
name: string;
|
|
278
|
+
description?: string;
|
|
279
|
+
type?: string;
|
|
280
|
+
project_uuid: string;
|
|
281
|
+
workspace_uuid?: string;
|
|
282
|
+
created_at: string;
|
|
283
|
+
updated_at: string;
|
|
284
|
+
settings?: MediaLibrarySettings;
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
declare interface MediaLibrarySettings {
|
|
288
|
+
max_file_size?: number;
|
|
289
|
+
allowed_types?: string[];
|
|
290
|
+
public?: boolean;
|
|
291
|
+
[key: string]: any;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
declare interface MediaFile {
|
|
295
|
+
uuid: string;
|
|
296
|
+
key: string;
|
|
297
|
+
name: string;
|
|
298
|
+
path: string;
|
|
299
|
+
size: number;
|
|
300
|
+
mime_type: string;
|
|
301
|
+
library_uuid: string;
|
|
302
|
+
created_at: string;
|
|
303
|
+
updated_at: string;
|
|
304
|
+
metadata?: MediaFileMetadata;
|
|
305
|
+
is_directory?: boolean;
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
declare interface MediaFileMetadata {
|
|
309
|
+
width?: number;
|
|
310
|
+
height?: number;
|
|
311
|
+
duration?: number;
|
|
312
|
+
[key: string]: any;
|
|
313
|
+
}
|
|
314
|
+
|
|
315
|
+
declare interface MediaListRequest {
|
|
316
|
+
library_uuid?: string;
|
|
317
|
+
library_ref?: string;
|
|
318
|
+
path?: string;
|
|
319
|
+
page?: number;
|
|
320
|
+
limit?: number;
|
|
321
|
+
search?: string;
|
|
322
|
+
mime_type?: string;
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
declare interface MediaListResponse {
|
|
326
|
+
files: MediaFile[];
|
|
327
|
+
total: number;
|
|
328
|
+
page: number;
|
|
329
|
+
limit: number;
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
declare interface MediaUploadRequest {
|
|
333
|
+
library_uuid?: string;
|
|
334
|
+
library_ref?: string;
|
|
335
|
+
path?: string;
|
|
336
|
+
file: File | Blob;
|
|
337
|
+
name?: string;
|
|
338
|
+
metadata?: Record<string, any>;
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
declare interface MediaDownloadRequest {
|
|
342
|
+
keys: string[];
|
|
343
|
+
zip?: boolean;
|
|
344
|
+
}
|
|
345
|
+
|
|
346
|
+
declare interface MediaShareRequest {
|
|
347
|
+
keys: string[];
|
|
348
|
+
expires_in?: number;
|
|
349
|
+
password?: string;
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
declare interface MediaShareResponse {
|
|
353
|
+
url: string;
|
|
354
|
+
expires_at?: string;
|
|
355
|
+
token?: string;
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
declare interface MediaDirectory {
|
|
359
|
+
name: string;
|
|
360
|
+
path: string;
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
declare interface MediaMoveRequest {
|
|
364
|
+
keys: string[];
|
|
365
|
+
destination: string;
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
declare interface MediaDeleteRequest {
|
|
369
|
+
keys: string[];
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
declare interface ExifData {
|
|
373
|
+
[key: string]: any;
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
declare interface Html2PdfRequest {
|
|
377
|
+
html: string;
|
|
378
|
+
options?: {
|
|
379
|
+
format?: "A4" | "Letter" | string;
|
|
380
|
+
orientation?: "portrait" | "landscape";
|
|
381
|
+
margin?: {
|
|
382
|
+
top?: string;
|
|
383
|
+
right?: string;
|
|
384
|
+
bottom?: string;
|
|
385
|
+
left?: string;
|
|
386
|
+
};
|
|
387
|
+
[key: string]: any;
|
|
388
|
+
};
|
|
389
|
+
output_path?: string;
|
|
390
|
+
}
|
|
391
|
+
|
|
392
|
+
declare interface ProjectModel {
|
|
393
|
+
uuid: string;
|
|
394
|
+
name: string;
|
|
395
|
+
description?: string;
|
|
396
|
+
created_at: string;
|
|
397
|
+
updated_at: string;
|
|
398
|
+
deleted_at?: string | null;
|
|
399
|
+
owner_uuid: string;
|
|
400
|
+
archived: boolean;
|
|
401
|
+
settings?: ProjectSettings;
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
declare interface ProjectSettings {
|
|
405
|
+
[key: string]: any;
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
declare interface ProjectUser {
|
|
409
|
+
uuid: string;
|
|
410
|
+
name: string;
|
|
411
|
+
email: string;
|
|
412
|
+
roles: string[];
|
|
413
|
+
created_at: string;
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
declare interface ProjectInvite {
|
|
417
|
+
uuid: string;
|
|
418
|
+
email: string;
|
|
419
|
+
roles: string[];
|
|
420
|
+
status: string;
|
|
421
|
+
created_at: string;
|
|
422
|
+
expires_at: string;
|
|
423
|
+
project_uuid: string;
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
declare interface Workspace {
|
|
427
|
+
uuid: string;
|
|
428
|
+
name: string;
|
|
429
|
+
description?: string;
|
|
430
|
+
project_uuid: string;
|
|
431
|
+
created_at: string;
|
|
432
|
+
updated_at: string;
|
|
433
|
+
deleted_at?: string | null;
|
|
434
|
+
}
|
|
435
|
+
|
|
436
|
+
declare interface Template {
|
|
437
|
+
id: string;
|
|
438
|
+
name: string;
|
|
439
|
+
description?: string;
|
|
440
|
+
version: string;
|
|
441
|
+
category?: string;
|
|
442
|
+
tags?: string[];
|
|
443
|
+
author?: string;
|
|
444
|
+
created_at?: string;
|
|
445
|
+
updated_at?: string;
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
declare interface TemplateInstallation {
|
|
449
|
+
template_id: string;
|
|
450
|
+
workspace_uuid: string;
|
|
451
|
+
version?: string;
|
|
452
|
+
config?: Record<string, any>;
|
|
453
|
+
}
|
|
454
|
+
|
|
455
|
+
declare interface Transaction {
|
|
456
|
+
uuid: string;
|
|
457
|
+
type: string;
|
|
458
|
+
amount: number;
|
|
459
|
+
status: string;
|
|
460
|
+
created_at: string;
|
|
461
|
+
metadata?: Record<string, any>;
|
|
462
|
+
}
|
|
463
|
+
|
|
242
464
|
declare interface UserModel {
|
|
243
465
|
uuid: string;
|
|
244
466
|
name: string;
|
|
@@ -275,6 +497,43 @@ declare interface UserClaims {
|
|
|
275
497
|
exp: number;
|
|
276
498
|
}
|
|
277
499
|
|
|
500
|
+
declare interface Role {
|
|
501
|
+
uuid: string;
|
|
502
|
+
CreatedAt: string;
|
|
503
|
+
UpdatedAt: string;
|
|
504
|
+
DeletedAt: string | null;
|
|
505
|
+
name: string;
|
|
506
|
+
level: number;
|
|
507
|
+
project_uuid: string;
|
|
508
|
+
is_admin: boolean;
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
declare interface EditRoleRequest {
|
|
512
|
+
permissions: string[];
|
|
513
|
+
workspaces: string[];
|
|
514
|
+
level: number;
|
|
515
|
+
}
|
|
516
|
+
|
|
517
|
+
declare interface CreateRoleRequest extends EditRoleRequest {
|
|
518
|
+
name: string;
|
|
519
|
+
}
|
|
520
|
+
|
|
521
|
+
declare interface RoleModel {
|
|
522
|
+
name: string;
|
|
523
|
+
permissions: string[];
|
|
524
|
+
workspaces: string[];
|
|
525
|
+
level: number;
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
declare interface Permission {
|
|
529
|
+
uuid: string;
|
|
530
|
+
CreatedAt: string;
|
|
531
|
+
UpdatedAt: string;
|
|
532
|
+
DeletedAt: string | null;
|
|
533
|
+
action: string;
|
|
534
|
+
role_uuid: string;
|
|
535
|
+
}
|
|
536
|
+
|
|
278
537
|
declare class APIUserConstructor extends PlatformBaseClientConstructor {
|
|
279
538
|
constructor();
|
|
280
539
|
auth(username: string, password: string, project: string): Promise<any>;
|
|
@@ -314,6 +573,7 @@ declare class ComponentConstructor extends PlatformBaseClientConstructor {
|
|
|
314
573
|
saveTemplatesDist(version: string, sdkVersion: string, engine: string, dist: Record<string, string>): Promise<any>;
|
|
315
574
|
workflow(event: string, input: any): Promise<any>;
|
|
316
575
|
function(name: string, input: any): Promise<any>;
|
|
576
|
+
revisions(uuid: string): Promise<any>;
|
|
317
577
|
}
|
|
318
578
|
|
|
319
579
|
declare class ComponentUtilsConstructor extends PlatformBaseClientConstructor {
|
|
@@ -322,6 +582,12 @@ declare class ComponentUtilsConstructor extends PlatformBaseClientConstructor {
|
|
|
322
582
|
create(data: any): Promise<any>;
|
|
323
583
|
}
|
|
324
584
|
|
|
585
|
+
declare class ConfigConstructor extends PlatformBaseClientConstructor {
|
|
586
|
+
constructor();
|
|
587
|
+
getUserConfig(): Promise<any>;
|
|
588
|
+
updateUserConfig(config: ConfigUpdateRequest): Promise<any>;
|
|
589
|
+
}
|
|
590
|
+
|
|
325
591
|
declare class DMSConstructor extends IntegrationsBaseClientConstructor {
|
|
326
592
|
constructor();
|
|
327
593
|
list(data: any): Promise<any>;
|
|
@@ -340,7 +606,7 @@ declare class DMSConstructor extends IntegrationsBaseClientConstructor {
|
|
|
340
606
|
convertData(lib: string, data: any, params: DataConversionParams): Promise<any>;
|
|
341
607
|
getDataInfo(lib: string, data: any, params: DataInfoParams): Promise<any>;
|
|
342
608
|
validateData(lib: string, data: any, params: DataValidationParams): Promise<any>;
|
|
343
|
-
jsonToCsv(lib: string, jsonData: any): Promise<any>;
|
|
609
|
+
jsonToCsv(lib: string, jsonData: any, options?: ConversionOptions): Promise<any>;
|
|
344
610
|
jsonToExcel(lib: string, jsonData: any, options?: ConversionOptions): Promise<any>;
|
|
345
611
|
csvToJson(lib: string, csvData: string): Promise<any>;
|
|
346
612
|
csvToExcel(lib: string, csvData: string, options?: ConversionOptions): Promise<any>;
|
|
@@ -378,9 +644,9 @@ declare class IntegrationsConstructor extends IntegrationsBaseClientConstructor
|
|
|
378
644
|
host?: string;
|
|
379
645
|
});
|
|
380
646
|
getSerbiaUtilities(): any;
|
|
381
|
-
getDMS():
|
|
382
|
-
getVPFR():
|
|
383
|
-
getInvoicing():
|
|
647
|
+
getDMS(): DMS;
|
|
648
|
+
getVPFR(): VPFR;
|
|
649
|
+
getInvoicing(): Invoicing;
|
|
384
650
|
getPayments(): Payments;
|
|
385
651
|
isInstalled(id: string): Promise<boolean>;
|
|
386
652
|
getInterfaceOf(id: string): any;
|
|
@@ -432,7 +698,6 @@ declare class PlatformConstructor extends PlatformBaseClientConstructor {
|
|
|
432
698
|
getPlatformBaseURL(): string;
|
|
433
699
|
apiUser(): APIUser;
|
|
434
700
|
function(): Functions;
|
|
435
|
-
role(): Roles;
|
|
436
701
|
user(): Users;
|
|
437
702
|
app(appType: string): Apps;
|
|
438
703
|
forge(): Forge;
|
|
@@ -443,6 +708,8 @@ declare class PlatformConstructor extends PlatformBaseClientConstructor {
|
|
|
443
708
|
system(): System;
|
|
444
709
|
workflow(): Workflow;
|
|
445
710
|
thunder(): Thunder;
|
|
711
|
+
project(): Project;
|
|
712
|
+
config(): Config;
|
|
446
713
|
}
|
|
447
714
|
|
|
448
715
|
declare class PlatformBaseClientConstructor extends BaseClientConstructor {
|
|
@@ -453,6 +720,55 @@ declare class PlatformBaseClientConstructor extends BaseClientConstructor {
|
|
|
453
720
|
});
|
|
454
721
|
}
|
|
455
722
|
|
|
723
|
+
declare class ProjectConstructor extends PlatformBaseClientConstructor {
|
|
724
|
+
constructor();
|
|
725
|
+
list(): Promise<any>;
|
|
726
|
+
create(data: {
|
|
727
|
+
name: string;
|
|
728
|
+
description?: string;
|
|
729
|
+
[key: string]: any;
|
|
730
|
+
}): Promise<any>;
|
|
731
|
+
info(): Promise<any>;
|
|
732
|
+
archive(): Promise<any>;
|
|
733
|
+
invite(emails: string[], roles: string[]): Promise<any>;
|
|
734
|
+
getInvites(): Promise<any>;
|
|
735
|
+
getInvite(uuid: string): Promise<any>;
|
|
736
|
+
acceptInvite(uuid: string): Promise<any>;
|
|
737
|
+
registerWithInvite(uuid: string, data: any): Promise<any>;
|
|
738
|
+
getUsers(): Promise<any>;
|
|
739
|
+
getUser(uuid: string): Promise<any>;
|
|
740
|
+
updateUser(uuid: string, data: any): Promise<any>;
|
|
741
|
+
deleteUser(uuid: string): Promise<any>;
|
|
742
|
+
updateSettings(settings: any): Promise<any>;
|
|
743
|
+
createWorkspace(data: {
|
|
744
|
+
name: string;
|
|
745
|
+
description?: string;
|
|
746
|
+
[key: string]: any;
|
|
747
|
+
}): Promise<any>;
|
|
748
|
+
updateWorkspace(uuid: string, data: any): Promise<any>;
|
|
749
|
+
deleteWorkspace(uuid: string): Promise<any>;
|
|
750
|
+
getAvailableTemplates(): Promise<any>;
|
|
751
|
+
searchTemplates(query: any): Promise<any>;
|
|
752
|
+
getTemplate(id: string): Promise<any>;
|
|
753
|
+
getTemplateByCode(code: string): Promise<any>;
|
|
754
|
+
getWorkspaceTemplates(): Promise<any>;
|
|
755
|
+
installTemplate(data: {
|
|
756
|
+
template_id: string;
|
|
757
|
+
workspace_uuid: string;
|
|
758
|
+
[key: string]: any;
|
|
759
|
+
}): Promise<any>;
|
|
760
|
+
uninstallTemplate(data: {
|
|
761
|
+
template_id: string;
|
|
762
|
+
workspace_uuid: string;
|
|
763
|
+
[key: string]: any;
|
|
764
|
+
}): Promise<any>;
|
|
765
|
+
upgradeTemplate(data: {
|
|
766
|
+
template_id: string;
|
|
767
|
+
workspace_uuid: string;
|
|
768
|
+
[key: string]: any;
|
|
769
|
+
}): Promise<any>;
|
|
770
|
+
}
|
|
771
|
+
|
|
456
772
|
declare class RatchetConstructor extends PlatformBaseClientConstructor {
|
|
457
773
|
constructor();
|
|
458
774
|
query(name: string, params: any): Promise<any>;
|
|
@@ -475,7 +791,8 @@ declare class SandboxConstructor extends PlatformBaseClientConstructor {
|
|
|
475
791
|
|
|
476
792
|
declare class SerbiaUtilConstructor extends IntegrationsBaseClientConstructor {
|
|
477
793
|
constructor();
|
|
478
|
-
|
|
794
|
+
nbsSearch(params: any): Promise<any>;
|
|
795
|
+
generateNbsIpsQrCode(params: NbsIpsQrCode): any;
|
|
479
796
|
getReceiptFromUrl(url: string, source: string): Promise<any>;
|
|
480
797
|
getContoList(): Promise<any>;
|
|
481
798
|
services(method: string, endpoint: string, params?: any): Promise<any>;
|
|
@@ -503,12 +820,22 @@ declare class ThunderConstructor extends PlatformBaseClientConstructor {
|
|
|
503
820
|
|
|
504
821
|
declare class UsersConstructor extends PlatformBaseClientConstructor {
|
|
505
822
|
constructor();
|
|
506
|
-
|
|
507
|
-
|
|
823
|
+
auth(username: string, password: string, project: string): Promise<any>;
|
|
824
|
+
resendConfirmationEmail(email: string): Promise<any>;
|
|
825
|
+
requestPasswordReset(email: string): Promise<any>;
|
|
508
826
|
getUser(): Promise<any>;
|
|
509
|
-
|
|
827
|
+
getClaims(): Promise<any>;
|
|
828
|
+
editProfile(data: any): Promise<any>;
|
|
829
|
+
getPermissions(): Promise<any>;
|
|
830
|
+
listPermissions(): Promise<any>;
|
|
831
|
+
createRole(role: CreateRoleRequest): Promise<any>;
|
|
832
|
+
deleteRole(uuid: string): Promise<AxiosResponse<{
|
|
833
|
+
status: boolean;
|
|
834
|
+
}>>;
|
|
835
|
+
listRoles(): Promise<any>;
|
|
836
|
+
getRoleModel(uuid: string): Promise<any>;
|
|
837
|
+
editRole(uuid: string, data: EditRoleRequest): Promise<any>;
|
|
510
838
|
permissions(): Promise<any>;
|
|
511
|
-
auth(username: string, password: string, project: string): Promise<any>;
|
|
512
839
|
}
|
|
513
840
|
|
|
514
841
|
declare class VPFRConstructor extends IntegrationsBaseClientConstructor {
|
|
@@ -529,7 +856,6 @@ interface ProtokolSDK {
|
|
|
529
856
|
System: typeof SystemConstructor;
|
|
530
857
|
Functions: typeof FunctionsConstructor;
|
|
531
858
|
APIUser: typeof APIUserConstructor;
|
|
532
|
-
Roles: typeof RolesConstructor;
|
|
533
859
|
Apps: typeof AppsConstructor;
|
|
534
860
|
Workflow: typeof WorkflowConstructor;
|
|
535
861
|
ComponentUtils: typeof ComponentUtilsConstructor;
|
|
@@ -541,6 +867,8 @@ interface ProtokolSDK {
|
|
|
541
867
|
DMS: typeof DMSConstructor;
|
|
542
868
|
SerbiaUtil: typeof SerbiaUtilConstructor;
|
|
543
869
|
VPFR: typeof VPFRConstructor;
|
|
870
|
+
Project: typeof ProjectConstructor;
|
|
871
|
+
Config: typeof ConfigConstructor;
|
|
544
872
|
}
|
|
545
873
|
|
|
546
874
|
declare const $sdk: {
|
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import IntegrationsBaseClient from "../integrationsBaseClient";
|
|
2
2
|
import { AxiosResponse } from "axios";
|
|
3
|
-
import { PDFFillOptions, DataConversionParams, DataValidationParams, DataInfoParams, DataInfo, DataValidationResult, ConversionOptions, HTML2PDFOptions } from "../../types/integrations";
|
|
3
|
+
import { PDFFillOptions, DataConversionParams, DataValidationParams, DataInfoParams, DataInfo, DataValidationResult, ConversionOptions, HTML2PDFOptions, PDF2HTMLOptions, MediaUploadPayload, MediaUploadBase64Payload } from "../../types/integrations";
|
|
4
4
|
/**
|
|
5
5
|
* Document Management System (DMS) API client
|
|
6
6
|
*
|
|
@@ -83,17 +83,57 @@ import { PDFFillOptions, DataConversionParams, DataValidationParams, DataInfoPar
|
|
|
83
83
|
export default class DMS extends IntegrationsBaseClient {
|
|
84
84
|
list(data: any): Promise<AxiosResponse<any, any>>;
|
|
85
85
|
libraries(): Promise<AxiosResponse<any, any>>;
|
|
86
|
-
|
|
86
|
+
/**
|
|
87
|
+
* Upload files using multipart form data
|
|
88
|
+
*
|
|
89
|
+
* @param payload - Upload configuration with files, directory, and options
|
|
90
|
+
* @returns Upload response from the server
|
|
91
|
+
*
|
|
92
|
+
* @example
|
|
93
|
+
* ```typescript
|
|
94
|
+
* const result = await dms.upload({
|
|
95
|
+
* files: [file1, file2],
|
|
96
|
+
* uploadDir: '/documents/invoices',
|
|
97
|
+
* public: true,
|
|
98
|
+
* replace: true,
|
|
99
|
+
* metadata: { category: 'finance' }
|
|
100
|
+
* });
|
|
101
|
+
* ```
|
|
102
|
+
*/
|
|
103
|
+
upload(payload: MediaUploadPayload): Promise<AxiosResponse<any, any> | undefined>;
|
|
87
104
|
delete(data: any): Promise<AxiosResponse<any, any>>;
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
105
|
+
/**
|
|
106
|
+
* Upload files using base64-encoded content
|
|
107
|
+
*
|
|
108
|
+
* @param data - Upload payload with base64-encoded files
|
|
109
|
+
* @returns Upload response from the server
|
|
110
|
+
*
|
|
111
|
+
* @example
|
|
112
|
+
* ```typescript
|
|
113
|
+
* const result = await dms.uploadBase64({
|
|
114
|
+
* path: '/documents/reports',
|
|
115
|
+
* is_public: false,
|
|
116
|
+
* replace: true,
|
|
117
|
+
* files: [
|
|
118
|
+
* {
|
|
119
|
+
* name: 'report.pdf',
|
|
120
|
+
* content_type: 'application/pdf',
|
|
121
|
+
* data: 'base64EncodedContent...'
|
|
122
|
+
* }
|
|
123
|
+
* ]
|
|
124
|
+
* });
|
|
125
|
+
* ```
|
|
126
|
+
*/
|
|
127
|
+
uploadBase64(data: MediaUploadBase64Payload): Promise<AxiosResponse<any, any>>;
|
|
128
|
+
getMedia(key: string, encoding: string): Promise<AxiosResponse<any, any>>;
|
|
129
|
+
download(key: string): Promise<AxiosResponse<any, any>>;
|
|
130
|
+
getExifData(key: string): Promise<AxiosResponse<any, any>>;
|
|
131
|
+
html2pdf(data: HTML2PDFOptions): Promise<AxiosResponse<any, any>>;
|
|
132
|
+
pdf2html(data: PDF2HTMLOptions): Promise<AxiosResponse<any, any>>;
|
|
133
|
+
createDir(path: string): Promise<AxiosResponse<any, any>>;
|
|
134
|
+
deleteDir(path: string): Promise<AxiosResponse<any, any>>;
|
|
135
|
+
dirs(data: string): Promise<AxiosResponse<any, any>>;
|
|
136
|
+
fillPdf(data: PDFFillOptions): Promise<AxiosResponse<any, any>>;
|
|
97
137
|
/**
|
|
98
138
|
* Convert data between different formats (JSON, CSV, Excel)
|
|
99
139
|
*
|
|
@@ -155,7 +195,7 @@ export default class DMS extends IntegrationsBaseClient {
|
|
|
155
195
|
* // excelResult.data is a Blob
|
|
156
196
|
* ```
|
|
157
197
|
*/
|
|
158
|
-
convertData(
|
|
198
|
+
convertData(data: any, params: DataConversionParams): Promise<AxiosResponse<any>>;
|
|
159
199
|
/**
|
|
160
200
|
* Get information about data format and structure
|
|
161
201
|
*
|
|
@@ -187,7 +227,7 @@ export default class DMS extends IntegrationsBaseClient {
|
|
|
187
227
|
* // }
|
|
188
228
|
* ```
|
|
189
229
|
*/
|
|
190
|
-
getDataInfo(
|
|
230
|
+
getDataInfo(data: any, params: DataInfoParams): Promise<AxiosResponse<DataInfo>>;
|
|
191
231
|
/**
|
|
192
232
|
* Validate data format without performing conversion
|
|
193
233
|
*
|
|
@@ -222,7 +262,7 @@ export default class DMS extends IntegrationsBaseClient {
|
|
|
222
262
|
* }
|
|
223
263
|
* ```
|
|
224
264
|
*/
|
|
225
|
-
validateData(
|
|
265
|
+
validateData(data: any, params: DataValidationParams): Promise<AxiosResponse<DataValidationResult>>;
|
|
226
266
|
/**
|
|
227
267
|
* Convert JSON data to CSV format
|
|
228
268
|
*
|
|
@@ -261,7 +301,7 @@ export default class DMS extends IntegrationsBaseClient {
|
|
|
261
301
|
* // Auto-detects header, items, and footer sections
|
|
262
302
|
* ```
|
|
263
303
|
*/
|
|
264
|
-
jsonToCsv(
|
|
304
|
+
jsonToCsv(jsonData: any, options?: ConversionOptions): Promise<AxiosResponse<string>>;
|
|
265
305
|
/**
|
|
266
306
|
* Convert JSON data to Excel (.xlsx) format
|
|
267
307
|
*
|
|
@@ -307,7 +347,7 @@ export default class DMS extends IntegrationsBaseClient {
|
|
|
307
347
|
* link.click();
|
|
308
348
|
* ```
|
|
309
349
|
*/
|
|
310
|
-
jsonToExcel(
|
|
350
|
+
jsonToExcel(jsonData: any, options?: ConversionOptions): Promise<AxiosResponse<Blob>>;
|
|
311
351
|
/**
|
|
312
352
|
* Convert CSV data to JSON format
|
|
313
353
|
*
|
|
@@ -330,7 +370,7 @@ export default class DMS extends IntegrationsBaseClient {
|
|
|
330
370
|
* // ]
|
|
331
371
|
* ```
|
|
332
372
|
*/
|
|
333
|
-
csvToJson(
|
|
373
|
+
csvToJson(csvData: string): Promise<AxiosResponse<any[]>>;
|
|
334
374
|
/**
|
|
335
375
|
* Convert CSV data to Excel (.xlsx) format
|
|
336
376
|
*
|
|
@@ -355,7 +395,7 @@ export default class DMS extends IntegrationsBaseClient {
|
|
|
355
395
|
* // Use url for download or further processing
|
|
356
396
|
* ```
|
|
357
397
|
*/
|
|
358
|
-
csvToExcel(
|
|
398
|
+
csvToExcel(csvData: string, options?: ConversionOptions): Promise<AxiosResponse<Blob>>;
|
|
359
399
|
/**
|
|
360
400
|
* Convert Excel (.xlsx) data to JSON format
|
|
361
401
|
*
|
|
@@ -382,7 +422,7 @@ export default class DMS extends IntegrationsBaseClient {
|
|
|
382
422
|
* const jsonFromBuffer = await dms.excelToJson(libraryRef, arrayBuffer);
|
|
383
423
|
* ```
|
|
384
424
|
*/
|
|
385
|
-
excelToJson(
|
|
425
|
+
excelToJson(excelData: Blob | ArrayBuffer, options?: ConversionOptions): Promise<AxiosResponse<any[]>>;
|
|
386
426
|
/**
|
|
387
427
|
* Convert Excel (.xlsx) data to CSV format
|
|
388
428
|
*
|
|
@@ -413,7 +453,7 @@ export default class DMS extends IntegrationsBaseClient {
|
|
|
413
453
|
* link.click();
|
|
414
454
|
* ```
|
|
415
455
|
*/
|
|
416
|
-
excelToCsv(
|
|
456
|
+
excelToCsv(excelData: Blob | ArrayBuffer, options?: ConversionOptions): Promise<AxiosResponse<string>>;
|
|
417
457
|
request(method: string, endpoint: string, params?: any): Promise<AxiosResponse<any, any>>;
|
|
418
458
|
requestv1(method: string, endpoint: string, params?: any): Promise<AxiosResponse<any, any>>;
|
|
419
459
|
}
|