@emilgroup/document-sdk-node 1.21.0 → 1.22.1-beta.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/.openapi-generator/FILES +0 -38
- package/README.md +2 -2
- package/api/default-api.ts +8 -4
- package/api/document-templates-api.ts +79 -75
- package/api/documents-api.ts +42 -38
- package/api/docx-templates-api.ts +16 -28
- package/api/layouts-api.ts +18 -28
- package/api/product-documents-api.ts +47 -238
- package/api/search-keywords-api.ts +2 -4
- package/api/searchable-document-owners-api.ts +2 -4
- package/api/searchable-documents-api.ts +20 -20
- package/dist/api/default-api.d.ts +8 -4
- package/dist/api/default-api.js +8 -4
- package/dist/api/document-templates-api.d.ts +62 -67
- package/dist/api/document-templates-api.js +55 -42
- package/dist/api/documents-api.d.ts +39 -36
- package/dist/api/documents-api.js +21 -13
- package/dist/api/docx-templates-api.d.ts +22 -28
- package/dist/api/docx-templates-api.js +4 -4
- package/dist/api/layouts-api.d.ts +23 -28
- package/dist/api/layouts-api.js +8 -8
- package/dist/api/product-documents-api.d.ts +37 -150
- package/dist/api/product-documents-api.js +29 -155
- package/dist/api/search-keywords-api.d.ts +3 -4
- package/dist/api/searchable-document-owners-api.d.ts +3 -4
- package/dist/api/searchable-documents-api.d.ts +16 -17
- package/dist/api/searchable-documents-api.js +15 -13
- package/dist/models/create-doc-template-request-dto.d.ts +2 -2
- package/dist/models/create-document-request-dto.d.ts +11 -10
- package/dist/models/create-document-request-dto.js +2 -1
- package/dist/models/create-presigned-post-request-dto.d.ts +5 -4
- package/dist/models/create-presigned-post-request-dto.js +2 -1
- package/dist/models/index.d.ts +0 -38
- package/dist/models/index.js +0 -38
- package/dist/models/list-searchable-document-owners-request-dto.d.ts +1 -8
- package/dist/models/list-searchable-document-owners-request-dto.js +0 -7
- package/dist/models/list-searchable-documents-request-dto.d.ts +1 -8
- package/dist/models/list-searchable-documents-request-dto.js +0 -7
- package/dist/models/update-doc-template-request-dto.d.ts +2 -2
- package/dist/models/update-document-request-dto.d.ts +5 -5
- package/dist/models/upload-docx-template-request-dto.d.ts +1 -1
- package/dist/models/upload-product-document-request-dto.d.ts +2 -2
- package/models/create-doc-template-request-dto.ts +2 -2
- package/models/create-document-request-dto.ts +12 -11
- package/models/create-presigned-post-request-dto.ts +6 -5
- package/models/index.ts +0 -38
- package/models/list-searchable-document-owners-request-dto.ts +1 -11
- package/models/list-searchable-documents-request-dto.ts +1 -11
- package/models/update-doc-template-request-dto.ts +2 -2
- package/models/update-document-request-dto.ts +5 -5
- package/models/upload-docx-template-request-dto.ts +1 -1
- package/models/upload-product-document-request-dto.ts +2 -2
- package/package.json +1 -1
- package/dist/models/create-doc-template-response-class.d.ts +0 -25
- package/dist/models/create-doc-template-response-class.js +0 -15
- package/dist/models/create-document-sync-response-class.d.ts +0 -25
- package/dist/models/create-document-sync-response-class.js +0 -15
- package/dist/models/create-layout-response-class.d.ts +0 -25
- package/dist/models/create-layout-response-class.js +0 -15
- package/dist/models/create-presigned-post-response-class.d.ts +0 -30
- package/dist/models/create-presigned-post-response-class.js +0 -15
- package/dist/models/delete-response-class.d.ts +0 -24
- package/dist/models/delete-response-class.js +0 -15
- package/dist/models/doc-template-class.d.ts +0 -92
- package/dist/models/doc-template-class.js +0 -15
- package/dist/models/document-class.d.ts +0 -158
- package/dist/models/document-class.js +0 -52
- package/dist/models/docx-template-class.d.ts +0 -90
- package/dist/models/docx-template-class.js +0 -15
- package/dist/models/download-document-request-dto.d.ts +0 -30
- package/dist/models/download-document-request-dto.js +0 -15
- package/dist/models/get-doc-template-request-dto.d.ts +0 -30
- package/dist/models/get-doc-template-request-dto.js +0 -15
- package/dist/models/get-doc-template-response-class.d.ts +0 -25
- package/dist/models/get-doc-template-response-class.js +0 -15
- package/dist/models/get-document-download-url-response-class.d.ts +0 -24
- package/dist/models/get-document-download-url-response-class.js +0 -15
- package/dist/models/get-docx-template-download-url-response-class.d.ts +0 -24
- package/dist/models/get-docx-template-download-url-response-class.js +0 -15
- package/dist/models/get-docx-template-response-class.d.ts +0 -25
- package/dist/models/get-docx-template-response-class.js +0 -15
- package/dist/models/get-layout-response-class.d.ts +0 -25
- package/dist/models/get-layout-response-class.js +0 -15
- package/dist/models/get-product-document-download-url-response-class.d.ts +0 -24
- package/dist/models/get-product-document-download-url-response-class.js +0 -15
- package/dist/models/get-product-document-response-class.d.ts +0 -25
- package/dist/models/get-product-document-response-class.js +0 -15
- package/dist/models/get-signed-s3-key-url-response-class.d.ts +0 -24
- package/dist/models/get-signed-s3-key-url-response-class.js +0 -15
- package/dist/models/grpc-create-doc-template-request-dto.d.ts +0 -55
- package/dist/models/grpc-create-doc-template-request-dto.js +0 -15
- package/dist/models/grpc-update-doc-template-request-dto.d.ts +0 -61
- package/dist/models/grpc-update-doc-template-request-dto.js +0 -15
- package/dist/models/html-template-class.d.ts +0 -66
- package/dist/models/html-template-class.js +0 -21
- package/dist/models/layout-class.d.ts +0 -79
- package/dist/models/layout-class.js +0 -15
- package/dist/models/list-doc-template-request-dto.d.ts +0 -54
- package/dist/models/list-doc-template-request-dto.js +0 -15
- package/dist/models/list-doc-templates-response-class.d.ts +0 -31
- package/dist/models/list-doc-templates-response-class.js +0 -15
- package/dist/models/list-documents-response-class.d.ts +0 -31
- package/dist/models/list-documents-response-class.js +0 -15
- package/dist/models/list-docx-templates-response-class.d.ts +0 -31
- package/dist/models/list-docx-templates-response-class.js +0 -15
- package/dist/models/list-layouts-response-class.d.ts +0 -31
- package/dist/models/list-layouts-response-class.js +0 -15
- package/dist/models/list-product-documents-response-class.d.ts +0 -31
- package/dist/models/list-product-documents-response-class.js +0 -15
- package/dist/models/list-search-keywords-response-class.d.ts +0 -24
- package/dist/models/list-search-keywords-response-class.js +0 -15
- package/dist/models/list-searchable-document-owners-response-class.d.ts +0 -25
- package/dist/models/list-searchable-document-owners-response-class.js +0 -15
- package/dist/models/list-searchable-documents-response-class.d.ts +0 -31
- package/dist/models/list-searchable-documents-response-class.js +0 -15
- package/dist/models/product-document-class.d.ts +0 -117
- package/dist/models/product-document-class.js +0 -24
- package/dist/models/searchable-document-class.d.ts +0 -66
- package/dist/models/searchable-document-class.js +0 -15
- package/dist/models/searchable-document-owner-class.d.ts +0 -30
- package/dist/models/searchable-document-owner-class.js +0 -15
- package/dist/models/update-doc-template-response-class.d.ts +0 -25
- package/dist/models/update-doc-template-response-class.js +0 -15
- package/dist/models/update-document-response-class.d.ts +0 -25
- package/dist/models/update-document-response-class.js +0 -15
- package/dist/models/update-docx-template-response-class.d.ts +0 -25
- package/dist/models/update-docx-template-response-class.js +0 -15
- package/dist/models/update-layout-response-class.d.ts +0 -25
- package/dist/models/update-layout-response-class.js +0 -15
- package/models/create-doc-template-response-class.ts +0 -31
- package/models/create-document-sync-response-class.ts +0 -31
- package/models/create-layout-response-class.ts +0 -31
- package/models/create-presigned-post-response-class.ts +0 -36
- package/models/delete-response-class.ts +0 -30
- package/models/doc-template-class.ts +0 -98
- package/models/document-class.ts +0 -168
- package/models/docx-template-class.ts +0 -96
- package/models/download-document-request-dto.ts +0 -36
- package/models/get-doc-template-request-dto.ts +0 -36
- package/models/get-doc-template-response-class.ts +0 -31
- package/models/get-document-download-url-response-class.ts +0 -30
- package/models/get-docx-template-download-url-response-class.ts +0 -30
- package/models/get-docx-template-response-class.ts +0 -31
- package/models/get-layout-response-class.ts +0 -31
- package/models/get-product-document-download-url-response-class.ts +0 -30
- package/models/get-product-document-response-class.ts +0 -31
- package/models/get-signed-s3-key-url-response-class.ts +0 -30
- package/models/grpc-create-doc-template-request-dto.ts +0 -61
- package/models/grpc-update-doc-template-request-dto.ts +0 -67
- package/models/html-template-class.ts +0 -75
- package/models/layout-class.ts +0 -85
- package/models/list-doc-template-request-dto.ts +0 -60
- package/models/list-doc-templates-response-class.ts +0 -37
- package/models/list-documents-response-class.ts +0 -37
- package/models/list-docx-templates-response-class.ts +0 -37
- package/models/list-layouts-response-class.ts +0 -37
- package/models/list-product-documents-response-class.ts +0 -37
- package/models/list-search-keywords-response-class.ts +0 -30
- package/models/list-searchable-document-owners-response-class.ts +0 -31
- package/models/list-searchable-documents-response-class.ts +0 -37
- package/models/product-document-class.ts +0 -126
- package/models/searchable-document-class.ts +0 -72
- package/models/searchable-document-owner-class.ts +0 -36
- package/models/update-doc-template-response-class.ts +0 -31
- package/models/update-document-response-class.ts +0 -31
- package/models/update-docx-template-response-class.ts +0 -31
- package/models/update-layout-response-class.ts +0 -31
package/.openapi-generator/FILES
CHANGED
|
@@ -18,64 +18,26 @@ configuration.ts
|
|
|
18
18
|
git_push.sh
|
|
19
19
|
index.ts
|
|
20
20
|
models/create-doc-template-request-dto.ts
|
|
21
|
-
models/create-doc-template-response-class.ts
|
|
22
21
|
models/create-document-request-dto.ts
|
|
23
|
-
models/create-document-sync-response-class.ts
|
|
24
22
|
models/create-html-template-dto.ts
|
|
25
23
|
models/create-layout-request-dto.ts
|
|
26
|
-
models/create-layout-response-class.ts
|
|
27
24
|
models/create-presigned-post-request-dto.ts
|
|
28
|
-
models/create-presigned-post-response-class.ts
|
|
29
25
|
models/delete-layout-request-dto.ts
|
|
30
26
|
models/delete-product-document-request-dto.ts
|
|
31
27
|
models/delete-request-dto.ts
|
|
32
|
-
models/delete-response-class.ts
|
|
33
|
-
models/doc-template-class.ts
|
|
34
|
-
models/document-class.ts
|
|
35
|
-
models/docx-template-class.ts
|
|
36
|
-
models/download-document-request-dto.ts
|
|
37
|
-
models/get-doc-template-request-dto.ts
|
|
38
|
-
models/get-doc-template-response-class.ts
|
|
39
|
-
models/get-document-download-url-response-class.ts
|
|
40
|
-
models/get-docx-template-download-url-response-class.ts
|
|
41
|
-
models/get-docx-template-response-class.ts
|
|
42
28
|
models/get-layout-request-dto.ts
|
|
43
|
-
models/get-layout-response-class.ts
|
|
44
|
-
models/get-product-document-download-url-response-class.ts
|
|
45
|
-
models/get-product-document-response-class.ts
|
|
46
|
-
models/get-signed-s3-key-url-response-class.ts
|
|
47
|
-
models/grpc-create-doc-template-request-dto.ts
|
|
48
|
-
models/grpc-update-doc-template-request-dto.ts
|
|
49
|
-
models/html-template-class.ts
|
|
50
29
|
models/index.ts
|
|
51
30
|
models/inline-response200.ts
|
|
52
31
|
models/inline-response503.ts
|
|
53
|
-
models/layout-class.ts
|
|
54
|
-
models/list-doc-template-request-dto.ts
|
|
55
|
-
models/list-doc-templates-response-class.ts
|
|
56
|
-
models/list-documents-response-class.ts
|
|
57
|
-
models/list-docx-templates-response-class.ts
|
|
58
|
-
models/list-layouts-response-class.ts
|
|
59
|
-
models/list-product-documents-response-class.ts
|
|
60
32
|
models/list-request-dto.ts
|
|
61
33
|
models/list-search-keywords-request-dto.ts
|
|
62
|
-
models/list-search-keywords-response-class.ts
|
|
63
34
|
models/list-searchable-document-owners-request-dto.ts
|
|
64
|
-
models/list-searchable-document-owners-response-class.ts
|
|
65
35
|
models/list-searchable-documents-request-dto.ts
|
|
66
|
-
models/list-searchable-documents-response-class.ts
|
|
67
|
-
models/product-document-class.ts
|
|
68
|
-
models/searchable-document-class.ts
|
|
69
|
-
models/searchable-document-owner-class.ts
|
|
70
36
|
models/shared-update-docx-template-request-dto.ts
|
|
71
37
|
models/update-doc-template-request-dto.ts
|
|
72
|
-
models/update-doc-template-response-class.ts
|
|
73
38
|
models/update-document-request-dto.ts
|
|
74
|
-
models/update-document-response-class.ts
|
|
75
|
-
models/update-docx-template-response-class.ts
|
|
76
39
|
models/update-html-template-dto.ts
|
|
77
40
|
models/update-layout-request-dto.ts
|
|
78
|
-
models/update-layout-response-class.ts
|
|
79
41
|
models/upload-docx-template-request-dto.ts
|
|
80
42
|
models/upload-product-document-request-dto.ts
|
|
81
43
|
package.json
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/document-sdk-node@1.
|
|
20
|
+
npm install @emilgroup/document-sdk-node@1.22.1-beta.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/document-sdk-node@1.
|
|
24
|
+
yarn add @emilgroup/document-sdk-node@1.22.1-beta.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `DocumentsApi`.
|
package/api/default-api.ts
CHANGED
|
@@ -35,7 +35,8 @@ const FormData = require('form-data');
|
|
|
35
35
|
export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
39
|
+
* @summary Health Check
|
|
39
40
|
* @param {*} [options] Override http request option.
|
|
40
41
|
* @throws {RequiredError}
|
|
41
42
|
*/
|
|
@@ -76,7 +77,8 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
76
77
|
const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
|
|
77
78
|
return {
|
|
78
79
|
/**
|
|
79
|
-
*
|
|
80
|
+
* Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
81
|
+
* @summary Health Check
|
|
80
82
|
* @param {*} [options] Override http request option.
|
|
81
83
|
* @throws {RequiredError}
|
|
82
84
|
*/
|
|
@@ -95,7 +97,8 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
95
97
|
const localVarFp = DefaultApiFp(configuration)
|
|
96
98
|
return {
|
|
97
99
|
/**
|
|
98
|
-
*
|
|
100
|
+
* Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
101
|
+
* @summary Health Check
|
|
99
102
|
* @param {*} [options] Override http request option.
|
|
100
103
|
* @throws {RequiredError}
|
|
101
104
|
*/
|
|
@@ -113,7 +116,8 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
113
116
|
*/
|
|
114
117
|
export class DefaultApi extends BaseAPI {
|
|
115
118
|
/**
|
|
116
|
-
*
|
|
119
|
+
* Returns the health status of the document service. This endpoint is used to monitor the operational status of the document service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
120
|
+
* @summary Health Check
|
|
117
121
|
* @param {*} [options] Override http request option.
|
|
118
122
|
* @throws {RequiredError}
|
|
119
123
|
* @memberof DefaultApi
|
|
@@ -23,17 +23,7 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
|
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { CreateDocTemplateRequestDto } from '../models';
|
|
25
25
|
// @ts-ignore
|
|
26
|
-
import { CreateDocTemplateResponseClass } from '../models';
|
|
27
|
-
// @ts-ignore
|
|
28
|
-
import { DeleteResponseClass } from '../models';
|
|
29
|
-
// @ts-ignore
|
|
30
|
-
import { GetDocTemplateResponseClass } from '../models';
|
|
31
|
-
// @ts-ignore
|
|
32
|
-
import { ListDocTemplatesResponseClass } from '../models';
|
|
33
|
-
// @ts-ignore
|
|
34
26
|
import { UpdateDocTemplateRequestDto } from '../models';
|
|
35
|
-
// @ts-ignore
|
|
36
|
-
import { UpdateDocTemplateResponseClass } from '../models';
|
|
37
27
|
// URLSearchParams not necessarily used
|
|
38
28
|
// @ts-ignore
|
|
39
29
|
import { URL, URLSearchParams } from 'url';
|
|
@@ -137,17 +127,19 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
|
|
|
137
127
|
};
|
|
138
128
|
},
|
|
139
129
|
/**
|
|
140
|
-
* Retrieves the details of the document template that was previously created.
|
|
130
|
+
* Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
|
|
141
131
|
* @summary Retrieve the document template
|
|
142
132
|
* @param {number} id
|
|
133
|
+
* @param {string} expand Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
143
134
|
* @param {string} [authorization] Bearer Token
|
|
144
|
-
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
145
135
|
* @param {*} [options] Override http request option.
|
|
146
136
|
* @throws {RequiredError}
|
|
147
137
|
*/
|
|
148
|
-
getDocTemplate: async (id: number,
|
|
138
|
+
getDocTemplate: async (id: number, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
149
139
|
// verify required parameter 'id' is not null or undefined
|
|
150
140
|
assertParamExists('getDocTemplate', 'id', id)
|
|
141
|
+
// verify required parameter 'expand' is not null or undefined
|
|
142
|
+
assertParamExists('getDocTemplate', 'expand', expand)
|
|
151
143
|
const localVarPath = `/documentservice/v1/doc-templates/{id}`
|
|
152
144
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
153
145
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -187,19 +179,31 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
|
|
|
187
179
|
};
|
|
188
180
|
},
|
|
189
181
|
/**
|
|
190
|
-
* Returns a list of document templates you have previously created.
|
|
182
|
+
* Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
191
183
|
* @summary List document templates
|
|
184
|
+
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
185
|
+
* @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
186
|
+
* @param {string} filter Filter response by productSlug, slug and name.
|
|
187
|
+
* @param {string} search Search document templates by name | slug
|
|
188
|
+
* @param {string} order Order response by createdAt.
|
|
189
|
+
* @param {string} expand Expand response by bodyTemplate.
|
|
192
190
|
* @param {string} [authorization] Bearer Token
|
|
193
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
194
|
-
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
195
|
-
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
196
|
-
* @param {string} [search] Search document templates by name | slug
|
|
197
|
-
* @param {string} [order] Order response by createdAt.
|
|
198
|
-
* @param {string} [expand] Expand response by bodyTemplate.
|
|
199
191
|
* @param {*} [options] Override http request option.
|
|
200
192
|
* @throws {RequiredError}
|
|
201
193
|
*/
|
|
202
|
-
listDocTemplates: async (
|
|
194
|
+
listDocTemplates: async (pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
195
|
+
// verify required parameter 'pageSize' is not null or undefined
|
|
196
|
+
assertParamExists('listDocTemplates', 'pageSize', pageSize)
|
|
197
|
+
// verify required parameter 'pageToken' is not null or undefined
|
|
198
|
+
assertParamExists('listDocTemplates', 'pageToken', pageToken)
|
|
199
|
+
// verify required parameter 'filter' is not null or undefined
|
|
200
|
+
assertParamExists('listDocTemplates', 'filter', filter)
|
|
201
|
+
// verify required parameter 'search' is not null or undefined
|
|
202
|
+
assertParamExists('listDocTemplates', 'search', search)
|
|
203
|
+
// verify required parameter 'order' is not null or undefined
|
|
204
|
+
assertParamExists('listDocTemplates', 'order', order)
|
|
205
|
+
// verify required parameter 'expand' is not null or undefined
|
|
206
|
+
assertParamExists('listDocTemplates', 'expand', expand)
|
|
203
207
|
const localVarPath = `/documentservice/v1/doc-templates`;
|
|
204
208
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
205
209
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -326,7 +330,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
326
330
|
* @param {*} [options] Override http request option.
|
|
327
331
|
* @throws {RequiredError}
|
|
328
332
|
*/
|
|
329
|
-
async createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
333
|
+
async createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
330
334
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createDocTemplate(createDocTemplateRequestDto, authorization, options);
|
|
331
335
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
332
336
|
},
|
|
@@ -338,38 +342,38 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
338
342
|
* @param {*} [options] Override http request option.
|
|
339
343
|
* @throws {RequiredError}
|
|
340
344
|
*/
|
|
341
|
-
async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
345
|
+
async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
342
346
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDocTemplate(id, authorization, options);
|
|
343
347
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
344
348
|
},
|
|
345
349
|
/**
|
|
346
|
-
* Retrieves the details of the document template that was previously created.
|
|
350
|
+
* Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
|
|
347
351
|
* @summary Retrieve the document template
|
|
348
352
|
* @param {number} id
|
|
353
|
+
* @param {string} expand Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
349
354
|
* @param {string} [authorization] Bearer Token
|
|
350
|
-
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
351
355
|
* @param {*} [options] Override http request option.
|
|
352
356
|
* @throws {RequiredError}
|
|
353
357
|
*/
|
|
354
|
-
async getDocTemplate(id: number,
|
|
355
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocTemplate(id,
|
|
358
|
+
async getDocTemplate(id: number, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
359
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocTemplate(id, expand, authorization, options);
|
|
356
360
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
357
361
|
},
|
|
358
362
|
/**
|
|
359
|
-
* Returns a list of document templates you have previously created.
|
|
363
|
+
* Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
360
364
|
* @summary List document templates
|
|
365
|
+
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
366
|
+
* @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
367
|
+
* @param {string} filter Filter response by productSlug, slug and name.
|
|
368
|
+
* @param {string} search Search document templates by name | slug
|
|
369
|
+
* @param {string} order Order response by createdAt.
|
|
370
|
+
* @param {string} expand Expand response by bodyTemplate.
|
|
361
371
|
* @param {string} [authorization] Bearer Token
|
|
362
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
363
|
-
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
364
|
-
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
365
|
-
* @param {string} [search] Search document templates by name | slug
|
|
366
|
-
* @param {string} [order] Order response by createdAt.
|
|
367
|
-
* @param {string} [expand] Expand response by bodyTemplate.
|
|
368
372
|
* @param {*} [options] Override http request option.
|
|
369
373
|
* @throws {RequiredError}
|
|
370
374
|
*/
|
|
371
|
-
async listDocTemplates(
|
|
372
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(
|
|
375
|
+
async listDocTemplates(pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
376
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(pageSize, pageToken, filter, search, order, expand, authorization, options);
|
|
373
377
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
374
378
|
},
|
|
375
379
|
/**
|
|
@@ -381,7 +385,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
381
385
|
* @param {*} [options] Override http request option.
|
|
382
386
|
* @throws {RequiredError}
|
|
383
387
|
*/
|
|
384
|
-
async updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
388
|
+
async updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
385
389
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateDocTemplate(id, updateDocTemplateRequestDto, authorization, options);
|
|
386
390
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
387
391
|
},
|
|
@@ -403,7 +407,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
403
407
|
* @param {*} [options] Override http request option.
|
|
404
408
|
* @throws {RequiredError}
|
|
405
409
|
*/
|
|
406
|
-
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
410
|
+
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
|
|
407
411
|
return localVarFp.createDocTemplate(createDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
408
412
|
},
|
|
409
413
|
/**
|
|
@@ -414,36 +418,36 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
414
418
|
* @param {*} [options] Override http request option.
|
|
415
419
|
* @throws {RequiredError}
|
|
416
420
|
*/
|
|
417
|
-
deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<
|
|
421
|
+
deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<void> {
|
|
418
422
|
return localVarFp.deleteDocTemplate(id, authorization, options).then((request) => request(axios, basePath));
|
|
419
423
|
},
|
|
420
424
|
/**
|
|
421
|
-
* Retrieves the details of the document template that was previously created.
|
|
425
|
+
* Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
|
|
422
426
|
* @summary Retrieve the document template
|
|
423
427
|
* @param {number} id
|
|
428
|
+
* @param {string} expand Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
424
429
|
* @param {string} [authorization] Bearer Token
|
|
425
|
-
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
426
430
|
* @param {*} [options] Override http request option.
|
|
427
431
|
* @throws {RequiredError}
|
|
428
432
|
*/
|
|
429
|
-
getDocTemplate(id: number,
|
|
430
|
-
return localVarFp.getDocTemplate(id,
|
|
433
|
+
getDocTemplate(id: number, expand: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
434
|
+
return localVarFp.getDocTemplate(id, expand, authorization, options).then((request) => request(axios, basePath));
|
|
431
435
|
},
|
|
432
436
|
/**
|
|
433
|
-
* Returns a list of document templates you have previously created.
|
|
437
|
+
* Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
434
438
|
* @summary List document templates
|
|
439
|
+
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
440
|
+
* @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
441
|
+
* @param {string} filter Filter response by productSlug, slug and name.
|
|
442
|
+
* @param {string} search Search document templates by name | slug
|
|
443
|
+
* @param {string} order Order response by createdAt.
|
|
444
|
+
* @param {string} expand Expand response by bodyTemplate.
|
|
435
445
|
* @param {string} [authorization] Bearer Token
|
|
436
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
437
|
-
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
438
|
-
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
439
|
-
* @param {string} [search] Search document templates by name | slug
|
|
440
|
-
* @param {string} [order] Order response by createdAt.
|
|
441
|
-
* @param {string} [expand] Expand response by bodyTemplate.
|
|
442
446
|
* @param {*} [options] Override http request option.
|
|
443
447
|
* @throws {RequiredError}
|
|
444
448
|
*/
|
|
445
|
-
listDocTemplates(
|
|
446
|
-
return localVarFp.listDocTemplates(
|
|
449
|
+
listDocTemplates(pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
450
|
+
return localVarFp.listDocTemplates(pageSize, pageToken, filter, search, order, expand, authorization, options).then((request) => request(axios, basePath));
|
|
447
451
|
},
|
|
448
452
|
/**
|
|
449
453
|
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -454,7 +458,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
454
458
|
* @param {*} [options] Override http request option.
|
|
455
459
|
* @throws {RequiredError}
|
|
456
460
|
*/
|
|
457
|
-
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
461
|
+
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
|
|
458
462
|
return localVarFp.updateDocTemplate(id, updateDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
459
463
|
},
|
|
460
464
|
};
|
|
@@ -516,18 +520,18 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
|
|
|
516
520
|
readonly id: number
|
|
517
521
|
|
|
518
522
|
/**
|
|
519
|
-
*
|
|
523
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
520
524
|
* @type {string}
|
|
521
525
|
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
522
526
|
*/
|
|
523
|
-
readonly
|
|
527
|
+
readonly expand: string
|
|
524
528
|
|
|
525
529
|
/**
|
|
526
|
-
*
|
|
530
|
+
* Bearer Token
|
|
527
531
|
* @type {string}
|
|
528
532
|
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
529
533
|
*/
|
|
530
|
-
readonly
|
|
534
|
+
readonly authorization?: string
|
|
531
535
|
}
|
|
532
536
|
|
|
533
537
|
/**
|
|
@@ -536,54 +540,54 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
|
|
|
536
540
|
* @interface DocumentTemplatesApiListDocTemplatesRequest
|
|
537
541
|
*/
|
|
538
542
|
export interface DocumentTemplatesApiListDocTemplatesRequest {
|
|
539
|
-
/**
|
|
540
|
-
* Bearer Token
|
|
541
|
-
* @type {string}
|
|
542
|
-
* @memberof DocumentTemplatesApiListDocTemplates
|
|
543
|
-
*/
|
|
544
|
-
readonly authorization?: string
|
|
545
|
-
|
|
546
543
|
/**
|
|
547
544
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
548
545
|
* @type {number}
|
|
549
546
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
550
547
|
*/
|
|
551
|
-
readonly pageSize
|
|
548
|
+
readonly pageSize: number
|
|
552
549
|
|
|
553
550
|
/**
|
|
554
551
|
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
555
552
|
* @type {string}
|
|
556
553
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
557
554
|
*/
|
|
558
|
-
readonly pageToken
|
|
555
|
+
readonly pageToken: string
|
|
559
556
|
|
|
560
557
|
/**
|
|
561
558
|
* Filter response by productSlug, slug and name.
|
|
562
559
|
* @type {string}
|
|
563
560
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
564
561
|
*/
|
|
565
|
-
readonly filter
|
|
562
|
+
readonly filter: string
|
|
566
563
|
|
|
567
564
|
/**
|
|
568
565
|
* Search document templates by name | slug
|
|
569
566
|
* @type {string}
|
|
570
567
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
571
568
|
*/
|
|
572
|
-
readonly search
|
|
569
|
+
readonly search: string
|
|
573
570
|
|
|
574
571
|
/**
|
|
575
572
|
* Order response by createdAt.
|
|
576
573
|
* @type {string}
|
|
577
574
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
578
575
|
*/
|
|
579
|
-
readonly order
|
|
576
|
+
readonly order: string
|
|
580
577
|
|
|
581
578
|
/**
|
|
582
579
|
* Expand response by bodyTemplate.
|
|
583
580
|
* @type {string}
|
|
584
581
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
585
582
|
*/
|
|
586
|
-
readonly expand
|
|
583
|
+
readonly expand: string
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* Bearer Token
|
|
587
|
+
* @type {string}
|
|
588
|
+
* @memberof DocumentTemplatesApiListDocTemplates
|
|
589
|
+
*/
|
|
590
|
+
readonly authorization?: string
|
|
587
591
|
}
|
|
588
592
|
|
|
589
593
|
/**
|
|
@@ -646,7 +650,7 @@ export class DocumentTemplatesApi extends BaseAPI {
|
|
|
646
650
|
}
|
|
647
651
|
|
|
648
652
|
/**
|
|
649
|
-
* Retrieves the details of the document template that was previously created.
|
|
653
|
+
* Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
|
|
650
654
|
* @summary Retrieve the document template
|
|
651
655
|
* @param {DocumentTemplatesApiGetDocTemplateRequest} requestParameters Request parameters.
|
|
652
656
|
* @param {*} [options] Override http request option.
|
|
@@ -654,19 +658,19 @@ export class DocumentTemplatesApi extends BaseAPI {
|
|
|
654
658
|
* @memberof DocumentTemplatesApi
|
|
655
659
|
*/
|
|
656
660
|
public getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig) {
|
|
657
|
-
return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.
|
|
661
|
+
return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
658
662
|
}
|
|
659
663
|
|
|
660
664
|
/**
|
|
661
|
-
* Returns a list of document templates you have previously created.
|
|
665
|
+
* Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
662
666
|
* @summary List document templates
|
|
663
667
|
* @param {DocumentTemplatesApiListDocTemplatesRequest} requestParameters Request parameters.
|
|
664
668
|
* @param {*} [options] Override http request option.
|
|
665
669
|
* @throws {RequiredError}
|
|
666
670
|
* @memberof DocumentTemplatesApi
|
|
667
671
|
*/
|
|
668
|
-
public listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest
|
|
669
|
-
return DocumentTemplatesApiFp(this.configuration).listDocTemplates(requestParameters.
|
|
672
|
+
public listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest, options?: AxiosRequestConfig) {
|
|
673
|
+
return DocumentTemplatesApiFp(this.configuration).listDocTemplates(requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
670
674
|
}
|
|
671
675
|
|
|
672
676
|
/**
|