@verdocs/js-sdk 2.0.21 → 2.0.23

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.
Files changed (7) hide show
  1. package/Templates/Pages.d.ts +7 -2
  2. package/Templates/Pages.js +2 -2
  3. package/Templates/TemplateDocuments.d.ts +5 -5
  4. package/Templates/TemplateDocuments.js +11 -6
  5. package/Templates/Templates.d.ts +20 -13
  6. package/Templates/Templates.js +10 -10
  7. package/package.json +1 -1
package/Templates/Pages.d.ts CHANGED
@@ -1,9 +1,14 @@
1
1
  import { IPage } from './Types';
2
2
  import { VerdocsEndpoint } from '../VerdocsEndpoint';
3
+ export interface ICreatePageParams {
4
+ document_id: string;
5
+ page_number: number;
6
+ sequence: number;
7
+ }
3
8
  /**
4
- * Add a page to a template
9
+ * Add a page to a template.
5
10
  */
6
- export declare const createPage: (endpoint: VerdocsEndpoint, templateId: string, params: IPage) => Promise<IPage>;
11
+ export declare const createPage: (endpoint: VerdocsEndpoint, templateId: string, params: ICreatePageParams) => Promise<IPage>;
7
12
  /**
8
13
  * Update a template page.
9
14
  */
package/Templates/Pages.js CHANGED
@@ -1,9 +1,9 @@
1
1
  /**
2
- * Add a page to a template
2
+ * Add a page to a template.
3
3
  */
4
4
  export var createPage = function (endpoint, templateId, params) {
5
5
  return endpoint.api //
6
- .post("/templates/".concat(templateId, "/pages/"), params)
6
+ .post("/templates/".concat(templateId, "/pages"), params)
7
7
  .then(function (r) { return r.data; });
8
8
  };
9
9
  /**
package/Templates/TemplateDocuments.d.ts CHANGED
@@ -11,7 +11,7 @@ import { ITemplateDocument } from './Types';
11
11
  * ```typescript
12
12
  * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
13
13
  *
14
- * await TemplateDocument.getDocuments(templateID);
14
+ * await TemplateDocument.getDocuments((VerdocsEndpoint.getDefault(), templateID);
15
15
  * ```
16
16
  */
17
17
  export declare const getTemplateDocuments: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateDocument[]>;
@@ -21,17 +21,17 @@ export declare const getTemplateDocuments: (endpoint: VerdocsEndpoint, templateI
21
21
  * ```typescript
22
22
  * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
23
23
  *
24
- * await TemplateDocument.createDocument(templateID, params);
24
+ * await TemplateDocument.createDocument((VerdocsEndpoint.getDefault(), templateID, params);
25
25
  * ```
26
26
  */
27
- export declare const createTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, params: any) => Promise<ITemplateDocument>;
27
+ export declare const createTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, file: File, onUploadProgress?: ((percent: number, loadedBytes: number, totalBytes: number) => void) | undefined) => Promise<ITemplateDocument>;
28
28
  /**
29
29
  * Get a specific Document.
30
30
  *
31
31
  * ```typescript
32
32
  * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
33
33
  *
34
- * await TemplateDocument.getDocument(templateID, documentID);
34
+ * await TemplateDocument.getDocument((VerdocsEndpoint.getDefault(), templateID, documentID);
35
35
  * ```
36
36
  */
37
37
  export declare const getTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<ITemplateDocument>;
@@ -41,7 +41,7 @@ export declare const getTemplateDocument: (endpoint: VerdocsEndpoint, templateId
41
41
  * ```typescript
42
42
  * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
43
43
  *
44
- * await TemplateDocument.deleteDocument(templateID, documentID);
44
+ * await TemplateDocument.deleteDocument((VerdocsEndpoint.getDefault(), templateID, documentID);
45
45
  * ```
46
46
  */
47
47
  export declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<any>;
package/Templates/TemplateDocuments.js CHANGED
@@ -45,7 +45,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
45
45
  * ```typescript
46
46
  * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
47
47
  *
48
- * await TemplateDocument.getDocuments(templateID);
48
+ * await TemplateDocument.getDocuments((VerdocsEndpoint.getDefault(), templateID);
49
49
  * ```
50
50
  */
51
51
  export var getTemplateDocuments = function (endpoint, templateId) {
@@ -59,12 +59,17 @@ export var getTemplateDocuments = function (endpoint, templateId) {
59
59
  * ```typescript
60
60
  * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
61
61
  *
62
- * await TemplateDocument.createDocument(templateID, params);
62
+ * await TemplateDocument.createDocument((VerdocsEndpoint.getDefault(), templateID, params);
63
63
  * ```
64
64
  */
65
- export var createTemplateDocument = function (endpoint, templateId, params) {
65
+ export var createTemplateDocument = function (endpoint, templateId, file, onUploadProgress) {
66
+ var formData = new FormData();
67
+ formData.append('document', file, file.name);
66
68
  return endpoint.api //
67
- .post("/templates/".concat(templateId, "/documents/"), params)
69
+ .post("/templates/".concat(templateId, "/documents"), formData, {
70
+ timeout: 10000,
71
+ onUploadProgress: function (event) { return onUploadProgress === null || onUploadProgress === void 0 ? void 0 : onUploadProgress(Math.floor((event.loaded * 100) / event.total), event.loaded, event.total); },
72
+ })
68
73
  .then(function (r) { return r.data; });
69
74
  };
70
75
  /**
@@ -73,7 +78,7 @@ export var createTemplateDocument = function (endpoint, templateId, params) {
73
78
  * ```typescript
74
79
  * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
75
80
  *
76
- * await TemplateDocument.getDocument(templateID, documentID);
81
+ * await TemplateDocument.getDocument((VerdocsEndpoint.getDefault(), templateID, documentID);
77
82
  * ```
78
83
  */
79
84
  export var getTemplateDocument = function (endpoint, templateId, documentId) {
@@ -87,7 +92,7 @@ export var getTemplateDocument = function (endpoint, templateId, documentId) {
87
92
  * ```typescript
88
93
  * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
89
94
  *
90
- * await TemplateDocument.deleteDocument(templateID, documentID);
95
+ * await TemplateDocument.deleteDocument((VerdocsEndpoint.getDefault(), templateID, documentID);
91
96
  * ```
92
97
  */
93
98
  export var deleteTemplateDocument = function (endpoint, templateId, documentId) {
package/Templates/Templates.d.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  *
5
5
  * @module
6
6
  */
7
- import { ITemplate, ITemplateOwnerInfo, ITemplatesSearchResult, ITemplatesSummary } from './Types';
7
+ import { ITemplate, ITemplateOwnerInfo, ITemplatesSearchResult, ITemplatesSummary, TTemplateSender } from './Types';
8
8
  import { VerdocsEndpoint } from '../VerdocsEndpoint';
9
9
  export interface IGetTemplatesParams {
10
10
  is_starred?: boolean;
@@ -17,10 +17,10 @@ export interface IGetTemplatesParams {
17
17
  * ```typescript
18
18
  * import {Templates} from '@verdocs/js-sdk/Templates';
19
19
  *
20
- * await Templates.getTemplates();
21
- * await Templates.getTemplates({ is_starred: true });
22
- * await Templates.getTemplates({ is_creator: true });
23
- * await Templates.getTemplates({ is_organization: true });
20
+ * await Templates.getTemplates((VerdocsEndpoint.getDefault());
21
+ * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_starred: true });
22
+ * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_creator: true });
23
+ * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_organization: true });
24
24
  * ```
25
25
  */
26
26
  export declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemplatesParams) => Promise<ITemplate[]>;
@@ -30,7 +30,7 @@ export declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemp
30
30
  * ```typescript
31
31
  * import {Templates} from '@verdocs/js-sdk/Templates';
32
32
  *
33
- * const template = await Templates.getTemplate('83da3d70-7857-4392-b876-c4592a304bc9');
33
+ * const template = await Templates.getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
34
34
  * ```
35
35
  */
36
36
  export declare const getTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
@@ -40,37 +40,44 @@ export declare const getTemplate: (endpoint: VerdocsEndpoint, templateId: string
40
40
  * ```typescript
41
41
  * import {Templates} from '@verdocs/js-sdk/Templates';
42
42
  *
43
- * const template = await Templates.getTemplateOwnerInfo('83da3d70-7857-4392-b876-c4592a304bc9');
43
+ * const template = await Templates.getTemplateOwnerInfo((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
44
44
  * ```
45
45
  */
46
46
  export declare const getTemplateOwnerInfo: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateOwnerInfo>;
47
+ export interface ITemplateCreateParams {
48
+ name: string;
49
+ is_personal?: boolean;
50
+ is_public?: boolean;
51
+ sender?: TTemplateSender;
52
+ description?: string;
53
+ }
47
54
  /**
48
55
  * Create a template.
49
56
  *
50
57
  * ```typescript
51
58
  * import {Templates} from '@verdocs/js-sdk/Templates';
52
59
  *
53
- * const newTemplate = await Templates.createTemplate({...});
60
+ * const newTemplate = await Templates.createTemplate((VerdocsEndpoint.getDefault(), {...});
54
61
  * ```
55
62
  */
56
- export declare const createTemplate: (endpoint: VerdocsEndpoint, params: any) => Promise<ITemplate>;
63
+ export declare const createTemplate: (endpoint: VerdocsEndpoint, params: ITemplateCreateParams) => Promise<ITemplate>;
57
64
  /**
58
65
  * Update a template.
59
66
  *
60
67
  * ```typescript
61
68
  * import {Templates} from '@verdocs/js-sdk/Templates';
62
69
  *
63
- * const updatedTemplate = await Templates.updateTemplate('83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
70
+ * const updatedTemplate = await Templates.updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
64
71
  * ```
65
72
  */
66
- export declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, params: any) => Promise<ITemplate>;
73
+ export declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, params: Partial<ITemplateCreateParams>) => Promise<ITemplate>;
67
74
  /**
68
75
  * Search for templates matching various criteria.
69
76
  *
70
77
  * ```typescript
71
78
  * import {Templates} from '@verdocs/js-sdk/Templates';
72
79
  *
73
- * const {result, page, total} = await Templates.search({ ... });
80
+ * const {result, page, total} = await Templates.search((VerdocsEndpoint.getDefault(), { ... });
74
81
  * ```
75
82
  */
76
83
  export declare const searchTemplates: (endpoint: VerdocsEndpoint, params: any) => Promise<ITemplatesSearchResult>;
@@ -101,7 +108,7 @@ export interface IGetTemplateSummaryParams {
101
108
  * ```typescript
102
109
  * import {Templates} from '@verdocs/js-sdk/Templates';
103
110
  *
104
- * const summary = await Templates.getSummary(0);
111
+ * const summary = await Templates.getSummary((VerdocsEndpoint.getDefault(), 0);
105
112
  * ```
106
113
  */
107
114
  export declare const getSummary: (endpoint: VerdocsEndpoint, params?: IGetTemplateSummaryParams) => Promise<ITemplatesSummary>;
package/Templates/Templates.js CHANGED
@@ -46,10 +46,10 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
46
46
  * ```typescript
47
47
  * import {Templates} from '@verdocs/js-sdk/Templates';
48
48
  *
49
- * await Templates.getTemplates();
50
- * await Templates.getTemplates({ is_starred: true });
51
- * await Templates.getTemplates({ is_creator: true });
52
- * await Templates.getTemplates({ is_organization: true });
49
+ * await Templates.getTemplates((VerdocsEndpoint.getDefault());
50
+ * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_starred: true });
51
+ * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_creator: true });
52
+ * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_organization: true });
53
53
  * ```
54
54
  */
55
55
  export var getTemplates = function (endpoint, params) {
@@ -63,7 +63,7 @@ export var getTemplates = function (endpoint, params) {
63
63
  * ```typescript
64
64
  * import {Templates} from '@verdocs/js-sdk/Templates';
65
65
  *
66
- * const template = await Templates.getTemplate('83da3d70-7857-4392-b876-c4592a304bc9');
66
+ * const template = await Templates.getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
67
67
  * ```
68
68
  */
69
69
  export var getTemplate = function (endpoint, templateId) {
@@ -77,7 +77,7 @@ export var getTemplate = function (endpoint, templateId) {
77
77
  * ```typescript
78
78
  * import {Templates} from '@verdocs/js-sdk/Templates';
79
79
  *
80
- * const template = await Templates.getTemplateOwnerInfo('83da3d70-7857-4392-b876-c4592a304bc9');
80
+ * const template = await Templates.getTemplateOwnerInfo((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
81
81
  * ```
82
82
  */
83
83
  export var getTemplateOwnerInfo = function (endpoint, templateId) {
@@ -91,7 +91,7 @@ export var getTemplateOwnerInfo = function (endpoint, templateId) {
91
91
  * ```typescript
92
92
  * import {Templates} from '@verdocs/js-sdk/Templates';
93
93
  *
94
- * const newTemplate = await Templates.createTemplate({...});
94
+ * const newTemplate = await Templates.createTemplate((VerdocsEndpoint.getDefault(), {...});
95
95
  * ```
96
96
  */
97
97
  export var createTemplate = function (endpoint, params) {
@@ -105,7 +105,7 @@ export var createTemplate = function (endpoint, params) {
105
105
  * ```typescript
106
106
  * import {Templates} from '@verdocs/js-sdk/Templates';
107
107
  *
108
- * const updatedTemplate = await Templates.updateTemplate('83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
108
+ * const updatedTemplate = await Templates.updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
109
109
  * ```
110
110
  */
111
111
  export var updateTemplate = function (endpoint, templateId, params) {
@@ -119,7 +119,7 @@ export var updateTemplate = function (endpoint, templateId, params) {
119
119
  * ```typescript
120
120
  * import {Templates} from '@verdocs/js-sdk/Templates';
121
121
  *
122
- * const {result, page, total} = await Templates.search({ ... });
122
+ * const {result, page, total} = await Templates.search((VerdocsEndpoint.getDefault(), { ... });
123
123
  * ```
124
124
  */
125
125
  export var searchTemplates = function (endpoint, params) { return __awaiter(void 0, void 0, void 0, function () {
@@ -135,7 +135,7 @@ export var searchTemplates = function (endpoint, params) { return __awaiter(void
135
135
  * ```typescript
136
136
  * import {Templates} from '@verdocs/js-sdk/Templates';
137
137
  *
138
- * const summary = await Templates.getSummary(0);
138
+ * const summary = await Templates.getSummary((VerdocsEndpoint.getDefault(), 0);
139
139
  * ```
140
140
  */
141
141
  export var getSummary = function (endpoint, params) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@verdocs/js-sdk",
3
- "version": "2.0.21",
3
+ "version": "2.0.23",
4
4
  "private": false,
5
5
  "homepage": "https://github.com/Verdocs/js-sdk",
6
6
  "description": "Verdocs JS SDK",