@emilgroup/document-sdk 1.22.0 → 1.22.1-beta.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/.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 +18 -30
- package/api/docx-templates-api.ts +16 -28
- package/api/layouts-api.ts +18 -28
- package/api/product-documents-api.ts +19 -226
- 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 +25 -31
- package/dist/api/documents-api.js +4 -4
- 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 +19 -141
- package/dist/api/product-documents-api.js +9 -143
- 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 +10 -10
- package/dist/models/create-presigned-post-request-dto.d.ts +4 -4
- 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 +10 -10
- package/models/create-presigned-post-request-dto.ts +4 -4
- 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 -165
- package/dist/models/document-class.js +0 -53
- 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 -175
- 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@1.22.
|
|
20
|
+
npm install @emilgroup/document-sdk@1.22.1-beta.1 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/document-sdk@1.22.
|
|
24
|
+
yarn add @emilgroup/document-sdk@1.22.1-beta.1
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `DocumentsApi`.
|
package/api/default-api.ts
CHANGED
|
@@ -31,7 +31,8 @@ import { InlineResponse503 } from '../models';
|
|
|
31
31
|
export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
32
|
return {
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* 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.
|
|
35
|
+
* @summary Health Check
|
|
35
36
|
* @param {*} [options] Override http request option.
|
|
36
37
|
* @throws {RequiredError}
|
|
37
38
|
*/
|
|
@@ -72,7 +73,8 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
72
73
|
const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
|
|
73
74
|
return {
|
|
74
75
|
/**
|
|
75
|
-
*
|
|
76
|
+
* 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.
|
|
77
|
+
* @summary Health Check
|
|
76
78
|
* @param {*} [options] Override http request option.
|
|
77
79
|
* @throws {RequiredError}
|
|
78
80
|
*/
|
|
@@ -91,7 +93,8 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
91
93
|
const localVarFp = DefaultApiFp(configuration)
|
|
92
94
|
return {
|
|
93
95
|
/**
|
|
94
|
-
*
|
|
96
|
+
* 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.
|
|
97
|
+
* @summary Health Check
|
|
95
98
|
* @param {*} [options] Override http request option.
|
|
96
99
|
* @throws {RequiredError}
|
|
97
100
|
*/
|
|
@@ -109,7 +112,8 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
109
112
|
*/
|
|
110
113
|
export class DefaultApi extends BaseAPI {
|
|
111
114
|
/**
|
|
112
|
-
*
|
|
115
|
+
* 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.
|
|
116
|
+
* @summary Health Check
|
|
113
117
|
* @param {*} [options] Override http request option.
|
|
114
118
|
* @throws {RequiredError}
|
|
115
119
|
* @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
|
/**
|
|
38
28
|
* DocumentTemplatesApi - axios parameter creator
|
|
39
29
|
* @export
|
|
@@ -133,17 +123,19 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
|
|
|
133
123
|
};
|
|
134
124
|
},
|
|
135
125
|
/**
|
|
136
|
-
* Retrieves the details of the document template that was previously created.
|
|
126
|
+
* 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.
|
|
137
127
|
* @summary Retrieve the document template
|
|
138
128
|
* @param {number} id
|
|
129
|
+
* @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.
|
|
139
130
|
* @param {string} [authorization] Bearer Token
|
|
140
|
-
* @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.
|
|
141
131
|
* @param {*} [options] Override http request option.
|
|
142
132
|
* @throws {RequiredError}
|
|
143
133
|
*/
|
|
144
|
-
getDocTemplate: async (id: number,
|
|
134
|
+
getDocTemplate: async (id: number, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
145
135
|
// verify required parameter 'id' is not null or undefined
|
|
146
136
|
assertParamExists('getDocTemplate', 'id', id)
|
|
137
|
+
// verify required parameter 'expand' is not null or undefined
|
|
138
|
+
assertParamExists('getDocTemplate', 'expand', expand)
|
|
147
139
|
const localVarPath = `/documentservice/v1/doc-templates/{id}`
|
|
148
140
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
149
141
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -183,19 +175,31 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
|
|
|
183
175
|
};
|
|
184
176
|
},
|
|
185
177
|
/**
|
|
186
|
-
* Returns a list of document templates you have previously created.
|
|
178
|
+
* 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.
|
|
187
179
|
* @summary List document templates
|
|
180
|
+
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
181
|
+
* @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.
|
|
182
|
+
* @param {string} filter Filter response by productSlug, slug and name.
|
|
183
|
+
* @param {string} search Search document templates by name | slug
|
|
184
|
+
* @param {string} order Order response by createdAt.
|
|
185
|
+
* @param {string} expand Expand response by bodyTemplate.
|
|
188
186
|
* @param {string} [authorization] Bearer Token
|
|
189
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
190
|
-
* @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.
|
|
191
|
-
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
192
|
-
* @param {string} [search] Search document templates by name | slug
|
|
193
|
-
* @param {string} [order] Order response by createdAt.
|
|
194
|
-
* @param {string} [expand] Expand response by bodyTemplate.
|
|
195
187
|
* @param {*} [options] Override http request option.
|
|
196
188
|
* @throws {RequiredError}
|
|
197
189
|
*/
|
|
198
|
-
listDocTemplates: async (
|
|
190
|
+
listDocTemplates: async (pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
191
|
+
// verify required parameter 'pageSize' is not null or undefined
|
|
192
|
+
assertParamExists('listDocTemplates', 'pageSize', pageSize)
|
|
193
|
+
// verify required parameter 'pageToken' is not null or undefined
|
|
194
|
+
assertParamExists('listDocTemplates', 'pageToken', pageToken)
|
|
195
|
+
// verify required parameter 'filter' is not null or undefined
|
|
196
|
+
assertParamExists('listDocTemplates', 'filter', filter)
|
|
197
|
+
// verify required parameter 'search' is not null or undefined
|
|
198
|
+
assertParamExists('listDocTemplates', 'search', search)
|
|
199
|
+
// verify required parameter 'order' is not null or undefined
|
|
200
|
+
assertParamExists('listDocTemplates', 'order', order)
|
|
201
|
+
// verify required parameter 'expand' is not null or undefined
|
|
202
|
+
assertParamExists('listDocTemplates', 'expand', expand)
|
|
199
203
|
const localVarPath = `/documentservice/v1/doc-templates`;
|
|
200
204
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
201
205
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -322,7 +326,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
322
326
|
* @param {*} [options] Override http request option.
|
|
323
327
|
* @throws {RequiredError}
|
|
324
328
|
*/
|
|
325
|
-
async createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
329
|
+
async createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
326
330
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createDocTemplate(createDocTemplateRequestDto, authorization, options);
|
|
327
331
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
328
332
|
},
|
|
@@ -334,38 +338,38 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
334
338
|
* @param {*} [options] Override http request option.
|
|
335
339
|
* @throws {RequiredError}
|
|
336
340
|
*/
|
|
337
|
-
async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
341
|
+
async deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
338
342
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDocTemplate(id, authorization, options);
|
|
339
343
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
340
344
|
},
|
|
341
345
|
/**
|
|
342
|
-
* Retrieves the details of the document template that was previously created.
|
|
346
|
+
* 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.
|
|
343
347
|
* @summary Retrieve the document template
|
|
344
348
|
* @param {number} id
|
|
349
|
+
* @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.
|
|
345
350
|
* @param {string} [authorization] Bearer Token
|
|
346
|
-
* @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.
|
|
347
351
|
* @param {*} [options] Override http request option.
|
|
348
352
|
* @throws {RequiredError}
|
|
349
353
|
*/
|
|
350
|
-
async getDocTemplate(id: number,
|
|
351
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocTemplate(id,
|
|
354
|
+
async getDocTemplate(id: number, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
355
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocTemplate(id, expand, authorization, options);
|
|
352
356
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
353
357
|
},
|
|
354
358
|
/**
|
|
355
|
-
* Returns a list of document templates you have previously created.
|
|
359
|
+
* 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.
|
|
356
360
|
* @summary List document templates
|
|
361
|
+
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
362
|
+
* @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.
|
|
363
|
+
* @param {string} filter Filter response by productSlug, slug and name.
|
|
364
|
+
* @param {string} search Search document templates by name | slug
|
|
365
|
+
* @param {string} order Order response by createdAt.
|
|
366
|
+
* @param {string} expand Expand response by bodyTemplate.
|
|
357
367
|
* @param {string} [authorization] Bearer Token
|
|
358
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
359
|
-
* @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.
|
|
360
|
-
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
361
|
-
* @param {string} [search] Search document templates by name | slug
|
|
362
|
-
* @param {string} [order] Order response by createdAt.
|
|
363
|
-
* @param {string} [expand] Expand response by bodyTemplate.
|
|
364
368
|
* @param {*} [options] Override http request option.
|
|
365
369
|
* @throws {RequiredError}
|
|
366
370
|
*/
|
|
367
|
-
async listDocTemplates(
|
|
368
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(
|
|
371
|
+
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>> {
|
|
372
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(pageSize, pageToken, filter, search, order, expand, authorization, options);
|
|
369
373
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
370
374
|
},
|
|
371
375
|
/**
|
|
@@ -377,7 +381,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
377
381
|
* @param {*} [options] Override http request option.
|
|
378
382
|
* @throws {RequiredError}
|
|
379
383
|
*/
|
|
380
|
-
async updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
384
|
+
async updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
381
385
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateDocTemplate(id, updateDocTemplateRequestDto, authorization, options);
|
|
382
386
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
383
387
|
},
|
|
@@ -399,7 +403,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
399
403
|
* @param {*} [options] Override http request option.
|
|
400
404
|
* @throws {RequiredError}
|
|
401
405
|
*/
|
|
402
|
-
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
406
|
+
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
|
|
403
407
|
return localVarFp.createDocTemplate(createDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
404
408
|
},
|
|
405
409
|
/**
|
|
@@ -410,36 +414,36 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
410
414
|
* @param {*} [options] Override http request option.
|
|
411
415
|
* @throws {RequiredError}
|
|
412
416
|
*/
|
|
413
|
-
deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<
|
|
417
|
+
deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<void> {
|
|
414
418
|
return localVarFp.deleteDocTemplate(id, authorization, options).then((request) => request(axios, basePath));
|
|
415
419
|
},
|
|
416
420
|
/**
|
|
417
|
-
* Retrieves the details of the document template that was previously created.
|
|
421
|
+
* 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.
|
|
418
422
|
* @summary Retrieve the document template
|
|
419
423
|
* @param {number} id
|
|
424
|
+
* @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.
|
|
420
425
|
* @param {string} [authorization] Bearer Token
|
|
421
|
-
* @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.
|
|
422
426
|
* @param {*} [options] Override http request option.
|
|
423
427
|
* @throws {RequiredError}
|
|
424
428
|
*/
|
|
425
|
-
getDocTemplate(id: number,
|
|
426
|
-
return localVarFp.getDocTemplate(id,
|
|
429
|
+
getDocTemplate(id: number, expand: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
430
|
+
return localVarFp.getDocTemplate(id, expand, authorization, options).then((request) => request(axios, basePath));
|
|
427
431
|
},
|
|
428
432
|
/**
|
|
429
|
-
* Returns a list of document templates you have previously created.
|
|
433
|
+
* 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.
|
|
430
434
|
* @summary List document templates
|
|
435
|
+
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
436
|
+
* @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.
|
|
437
|
+
* @param {string} filter Filter response by productSlug, slug and name.
|
|
438
|
+
* @param {string} search Search document templates by name | slug
|
|
439
|
+
* @param {string} order Order response by createdAt.
|
|
440
|
+
* @param {string} expand Expand response by bodyTemplate.
|
|
431
441
|
* @param {string} [authorization] Bearer Token
|
|
432
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
433
|
-
* @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.
|
|
434
|
-
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
435
|
-
* @param {string} [search] Search document templates by name | slug
|
|
436
|
-
* @param {string} [order] Order response by createdAt.
|
|
437
|
-
* @param {string} [expand] Expand response by bodyTemplate.
|
|
438
442
|
* @param {*} [options] Override http request option.
|
|
439
443
|
* @throws {RequiredError}
|
|
440
444
|
*/
|
|
441
|
-
listDocTemplates(
|
|
442
|
-
return localVarFp.listDocTemplates(
|
|
445
|
+
listDocTemplates(pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
446
|
+
return localVarFp.listDocTemplates(pageSize, pageToken, filter, search, order, expand, authorization, options).then((request) => request(axios, basePath));
|
|
443
447
|
},
|
|
444
448
|
/**
|
|
445
449
|
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -450,7 +454,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
450
454
|
* @param {*} [options] Override http request option.
|
|
451
455
|
* @throws {RequiredError}
|
|
452
456
|
*/
|
|
453
|
-
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
457
|
+
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
|
|
454
458
|
return localVarFp.updateDocTemplate(id, updateDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
455
459
|
},
|
|
456
460
|
};
|
|
@@ -512,18 +516,18 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
|
|
|
512
516
|
readonly id: number
|
|
513
517
|
|
|
514
518
|
/**
|
|
515
|
-
*
|
|
519
|
+
* 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.
|
|
516
520
|
* @type {string}
|
|
517
521
|
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
518
522
|
*/
|
|
519
|
-
readonly
|
|
523
|
+
readonly expand: string
|
|
520
524
|
|
|
521
525
|
/**
|
|
522
|
-
*
|
|
526
|
+
* Bearer Token
|
|
523
527
|
* @type {string}
|
|
524
528
|
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
525
529
|
*/
|
|
526
|
-
readonly
|
|
530
|
+
readonly authorization?: string
|
|
527
531
|
}
|
|
528
532
|
|
|
529
533
|
/**
|
|
@@ -532,54 +536,54 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
|
|
|
532
536
|
* @interface DocumentTemplatesApiListDocTemplatesRequest
|
|
533
537
|
*/
|
|
534
538
|
export interface DocumentTemplatesApiListDocTemplatesRequest {
|
|
535
|
-
/**
|
|
536
|
-
* Bearer Token
|
|
537
|
-
* @type {string}
|
|
538
|
-
* @memberof DocumentTemplatesApiListDocTemplates
|
|
539
|
-
*/
|
|
540
|
-
readonly authorization?: string
|
|
541
|
-
|
|
542
539
|
/**
|
|
543
540
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
544
541
|
* @type {number}
|
|
545
542
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
546
543
|
*/
|
|
547
|
-
readonly pageSize
|
|
544
|
+
readonly pageSize: number
|
|
548
545
|
|
|
549
546
|
/**
|
|
550
547
|
* 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.
|
|
551
548
|
* @type {string}
|
|
552
549
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
553
550
|
*/
|
|
554
|
-
readonly pageToken
|
|
551
|
+
readonly pageToken: string
|
|
555
552
|
|
|
556
553
|
/**
|
|
557
554
|
* Filter response by productSlug, slug and name.
|
|
558
555
|
* @type {string}
|
|
559
556
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
560
557
|
*/
|
|
561
|
-
readonly filter
|
|
558
|
+
readonly filter: string
|
|
562
559
|
|
|
563
560
|
/**
|
|
564
561
|
* Search document templates by name | slug
|
|
565
562
|
* @type {string}
|
|
566
563
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
567
564
|
*/
|
|
568
|
-
readonly search
|
|
565
|
+
readonly search: string
|
|
569
566
|
|
|
570
567
|
/**
|
|
571
568
|
* Order response by createdAt.
|
|
572
569
|
* @type {string}
|
|
573
570
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
574
571
|
*/
|
|
575
|
-
readonly order
|
|
572
|
+
readonly order: string
|
|
576
573
|
|
|
577
574
|
/**
|
|
578
575
|
* Expand response by bodyTemplate.
|
|
579
576
|
* @type {string}
|
|
580
577
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
581
578
|
*/
|
|
582
|
-
readonly expand
|
|
579
|
+
readonly expand: string
|
|
580
|
+
|
|
581
|
+
/**
|
|
582
|
+
* Bearer Token
|
|
583
|
+
* @type {string}
|
|
584
|
+
* @memberof DocumentTemplatesApiListDocTemplates
|
|
585
|
+
*/
|
|
586
|
+
readonly authorization?: string
|
|
583
587
|
}
|
|
584
588
|
|
|
585
589
|
/**
|
|
@@ -642,7 +646,7 @@ export class DocumentTemplatesApi extends BaseAPI {
|
|
|
642
646
|
}
|
|
643
647
|
|
|
644
648
|
/**
|
|
645
|
-
* Retrieves the details of the document template that was previously created.
|
|
649
|
+
* 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.
|
|
646
650
|
* @summary Retrieve the document template
|
|
647
651
|
* @param {DocumentTemplatesApiGetDocTemplateRequest} requestParameters Request parameters.
|
|
648
652
|
* @param {*} [options] Override http request option.
|
|
@@ -650,19 +654,19 @@ export class DocumentTemplatesApi extends BaseAPI {
|
|
|
650
654
|
* @memberof DocumentTemplatesApi
|
|
651
655
|
*/
|
|
652
656
|
public getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig) {
|
|
653
|
-
return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.
|
|
657
|
+
return DocumentTemplatesApiFp(this.configuration).getDocTemplate(requestParameters.id, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
654
658
|
}
|
|
655
659
|
|
|
656
660
|
/**
|
|
657
|
-
* Returns a list of document templates you have previously created.
|
|
661
|
+
* 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.
|
|
658
662
|
* @summary List document templates
|
|
659
663
|
* @param {DocumentTemplatesApiListDocTemplatesRequest} requestParameters Request parameters.
|
|
660
664
|
* @param {*} [options] Override http request option.
|
|
661
665
|
* @throws {RequiredError}
|
|
662
666
|
* @memberof DocumentTemplatesApi
|
|
663
667
|
*/
|
|
664
|
-
public listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest
|
|
665
|
-
return DocumentTemplatesApiFp(this.configuration).listDocTemplates(requestParameters.
|
|
668
|
+
public listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest, options?: AxiosRequestConfig) {
|
|
669
|
+
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));
|
|
666
670
|
}
|
|
667
671
|
|
|
668
672
|
/**
|