@emilgroup/document-sdk-node 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/dist/api/default-api.js
CHANGED
|
@@ -97,7 +97,8 @@ var DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
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
|
|
101
102
|
* @param {*} [options] Override http request option.
|
|
102
103
|
* @throws {RequiredError}
|
|
103
104
|
*/
|
|
@@ -136,7 +137,8 @@ var DefaultApiFp = function (configuration) {
|
|
|
136
137
|
var localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
|
|
137
138
|
return {
|
|
138
139
|
/**
|
|
139
|
-
*
|
|
140
|
+
* 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.
|
|
141
|
+
* @summary Health Check
|
|
140
142
|
* @param {*} [options] Override http request option.
|
|
141
143
|
* @throws {RequiredError}
|
|
142
144
|
*/
|
|
@@ -164,7 +166,8 @@ var DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
164
166
|
var localVarFp = (0, exports.DefaultApiFp)(configuration);
|
|
165
167
|
return {
|
|
166
168
|
/**
|
|
167
|
-
*
|
|
169
|
+
* 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.
|
|
170
|
+
* @summary Health Check
|
|
168
171
|
* @param {*} [options] Override http request option.
|
|
169
172
|
* @throws {RequiredError}
|
|
170
173
|
*/
|
|
@@ -186,7 +189,8 @@ var DefaultApi = /** @class */ (function (_super) {
|
|
|
186
189
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
187
190
|
}
|
|
188
191
|
/**
|
|
189
|
-
*
|
|
192
|
+
* 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.
|
|
193
|
+
* @summary Health Check
|
|
190
194
|
* @param {*} [options] Override http request option.
|
|
191
195
|
* @throws {RequiredError}
|
|
192
196
|
* @memberof DefaultApi
|
|
@@ -13,12 +13,7 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreateDocTemplateRequestDto } from '../models';
|
|
16
|
-
import { CreateDocTemplateResponseClass } from '../models';
|
|
17
|
-
import { DeleteResponseClass } from '../models';
|
|
18
|
-
import { GetDocTemplateResponseClass } from '../models';
|
|
19
|
-
import { ListDocTemplatesResponseClass } from '../models';
|
|
20
16
|
import { UpdateDocTemplateRequestDto } from '../models';
|
|
21
|
-
import { UpdateDocTemplateResponseClass } from '../models';
|
|
22
17
|
/**
|
|
23
18
|
* DocumentTemplatesApi - axios parameter creator
|
|
24
19
|
* @export
|
|
@@ -43,29 +38,29 @@ export declare const DocumentTemplatesApiAxiosParamCreator: (configuration?: Con
|
|
|
43
38
|
*/
|
|
44
39
|
deleteDocTemplate: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
40
|
/**
|
|
46
|
-
* Retrieves the details of the document template that was previously created.
|
|
41
|
+
* 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.
|
|
47
42
|
* @summary Retrieve the document template
|
|
48
43
|
* @param {number} id
|
|
44
|
+
* @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.
|
|
49
45
|
* @param {string} [authorization] Bearer Token
|
|
50
|
-
* @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.
|
|
51
46
|
* @param {*} [options] Override http request option.
|
|
52
47
|
* @throws {RequiredError}
|
|
53
48
|
*/
|
|
54
|
-
getDocTemplate: (id: number,
|
|
49
|
+
getDocTemplate: (id: number, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
50
|
/**
|
|
56
|
-
* Returns a list of document templates you have previously created.
|
|
51
|
+
* 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.
|
|
57
52
|
* @summary List document templates
|
|
53
|
+
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
54
|
+
* @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.
|
|
55
|
+
* @param {string} filter Filter response by productSlug, slug and name.
|
|
56
|
+
* @param {string} search Search document templates by name | slug
|
|
57
|
+
* @param {string} order Order response by createdAt.
|
|
58
|
+
* @param {string} expand Expand response by bodyTemplate.
|
|
58
59
|
* @param {string} [authorization] Bearer Token
|
|
59
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
60
|
-
* @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.
|
|
61
|
-
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
62
|
-
* @param {string} [search] Search document templates by name | slug
|
|
63
|
-
* @param {string} [order] Order response by createdAt.
|
|
64
|
-
* @param {string} [expand] Expand response by bodyTemplate.
|
|
65
60
|
* @param {*} [options] Override http request option.
|
|
66
61
|
* @throws {RequiredError}
|
|
67
62
|
*/
|
|
68
|
-
listDocTemplates: (
|
|
63
|
+
listDocTemplates: (pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
64
|
/**
|
|
70
65
|
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
71
66
|
* @summary Update the document template
|
|
@@ -90,7 +85,7 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
|
|
|
90
85
|
* @param {*} [options] Override http request option.
|
|
91
86
|
* @throws {RequiredError}
|
|
92
87
|
*/
|
|
93
|
-
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
88
|
+
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
94
89
|
/**
|
|
95
90
|
* Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
|
|
96
91
|
* @summary Delete the document template
|
|
@@ -99,31 +94,31 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
|
|
|
99
94
|
* @param {*} [options] Override http request option.
|
|
100
95
|
* @throws {RequiredError}
|
|
101
96
|
*/
|
|
102
|
-
deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
97
|
+
deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
103
98
|
/**
|
|
104
|
-
* Retrieves the details of the document template that was previously created.
|
|
99
|
+
* 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.
|
|
105
100
|
* @summary Retrieve the document template
|
|
106
101
|
* @param {number} id
|
|
102
|
+
* @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.
|
|
107
103
|
* @param {string} [authorization] Bearer Token
|
|
108
|
-
* @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.
|
|
109
104
|
* @param {*} [options] Override http request option.
|
|
110
105
|
* @throws {RequiredError}
|
|
111
106
|
*/
|
|
112
|
-
getDocTemplate(id: number,
|
|
107
|
+
getDocTemplate(id: number, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
113
108
|
/**
|
|
114
|
-
* Returns a list of document templates you have previously created.
|
|
109
|
+
* 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.
|
|
115
110
|
* @summary List document templates
|
|
111
|
+
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
112
|
+
* @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.
|
|
113
|
+
* @param {string} filter Filter response by productSlug, slug and name.
|
|
114
|
+
* @param {string} search Search document templates by name | slug
|
|
115
|
+
* @param {string} order Order response by createdAt.
|
|
116
|
+
* @param {string} expand Expand response by bodyTemplate.
|
|
116
117
|
* @param {string} [authorization] Bearer Token
|
|
117
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
118
|
-
* @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.
|
|
119
|
-
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
120
|
-
* @param {string} [search] Search document templates by name | slug
|
|
121
|
-
* @param {string} [order] Order response by createdAt.
|
|
122
|
-
* @param {string} [expand] Expand response by bodyTemplate.
|
|
123
118
|
* @param {*} [options] Override http request option.
|
|
124
119
|
* @throws {RequiredError}
|
|
125
120
|
*/
|
|
126
|
-
listDocTemplates(
|
|
121
|
+
listDocTemplates(pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
127
122
|
/**
|
|
128
123
|
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
129
124
|
* @summary Update the document template
|
|
@@ -133,7 +128,7 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
|
|
|
133
128
|
* @param {*} [options] Override http request option.
|
|
134
129
|
* @throws {RequiredError}
|
|
135
130
|
*/
|
|
136
|
-
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
131
|
+
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
137
132
|
};
|
|
138
133
|
/**
|
|
139
134
|
* DocumentTemplatesApi - factory interface
|
|
@@ -148,7 +143,7 @@ export declare const DocumentTemplatesApiFactory: (configuration?: Configuration
|
|
|
148
143
|
* @param {*} [options] Override http request option.
|
|
149
144
|
* @throws {RequiredError}
|
|
150
145
|
*/
|
|
151
|
-
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
146
|
+
createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
|
|
152
147
|
/**
|
|
153
148
|
* Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
|
|
154
149
|
* @summary Delete the document template
|
|
@@ -157,31 +152,31 @@ export declare const DocumentTemplatesApiFactory: (configuration?: Configuration
|
|
|
157
152
|
* @param {*} [options] Override http request option.
|
|
158
153
|
* @throws {RequiredError}
|
|
159
154
|
*/
|
|
160
|
-
deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<
|
|
155
|
+
deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<void>;
|
|
161
156
|
/**
|
|
162
|
-
* Retrieves the details of the document template that was previously created.
|
|
157
|
+
* 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.
|
|
163
158
|
* @summary Retrieve the document template
|
|
164
159
|
* @param {number} id
|
|
160
|
+
* @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.
|
|
165
161
|
* @param {string} [authorization] Bearer Token
|
|
166
|
-
* @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.
|
|
167
162
|
* @param {*} [options] Override http request option.
|
|
168
163
|
* @throws {RequiredError}
|
|
169
164
|
*/
|
|
170
|
-
getDocTemplate(id: number,
|
|
165
|
+
getDocTemplate(id: number, expand: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
171
166
|
/**
|
|
172
|
-
* Returns a list of document templates you have previously created.
|
|
167
|
+
* 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.
|
|
173
168
|
* @summary List document templates
|
|
169
|
+
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
170
|
+
* @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.
|
|
171
|
+
* @param {string} filter Filter response by productSlug, slug and name.
|
|
172
|
+
* @param {string} search Search document templates by name | slug
|
|
173
|
+
* @param {string} order Order response by createdAt.
|
|
174
|
+
* @param {string} expand Expand response by bodyTemplate.
|
|
174
175
|
* @param {string} [authorization] Bearer Token
|
|
175
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
176
|
-
* @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.
|
|
177
|
-
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
178
|
-
* @param {string} [search] Search document templates by name | slug
|
|
179
|
-
* @param {string} [order] Order response by createdAt.
|
|
180
|
-
* @param {string} [expand] Expand response by bodyTemplate.
|
|
181
176
|
* @param {*} [options] Override http request option.
|
|
182
177
|
* @throws {RequiredError}
|
|
183
178
|
*/
|
|
184
|
-
listDocTemplates(
|
|
179
|
+
listDocTemplates(pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
185
180
|
/**
|
|
186
181
|
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
187
182
|
* @summary Update the document template
|
|
@@ -191,7 +186,7 @@ export declare const DocumentTemplatesApiFactory: (configuration?: Configuration
|
|
|
191
186
|
* @param {*} [options] Override http request option.
|
|
192
187
|
* @throws {RequiredError}
|
|
193
188
|
*/
|
|
194
|
-
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
189
|
+
updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
|
|
195
190
|
};
|
|
196
191
|
/**
|
|
197
192
|
* Request parameters for createDocTemplate operation in DocumentTemplatesApi.
|
|
@@ -244,17 +239,17 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
|
|
|
244
239
|
*/
|
|
245
240
|
readonly id: number;
|
|
246
241
|
/**
|
|
247
|
-
*
|
|
242
|
+
* 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.
|
|
248
243
|
* @type {string}
|
|
249
244
|
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
250
245
|
*/
|
|
251
|
-
readonly
|
|
246
|
+
readonly expand: string;
|
|
252
247
|
/**
|
|
253
|
-
*
|
|
248
|
+
* Bearer Token
|
|
254
249
|
* @type {string}
|
|
255
250
|
* @memberof DocumentTemplatesApiGetDocTemplate
|
|
256
251
|
*/
|
|
257
|
-
readonly
|
|
252
|
+
readonly authorization?: string;
|
|
258
253
|
}
|
|
259
254
|
/**
|
|
260
255
|
* Request parameters for listDocTemplates operation in DocumentTemplatesApi.
|
|
@@ -262,48 +257,48 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
|
|
|
262
257
|
* @interface DocumentTemplatesApiListDocTemplatesRequest
|
|
263
258
|
*/
|
|
264
259
|
export interface DocumentTemplatesApiListDocTemplatesRequest {
|
|
265
|
-
/**
|
|
266
|
-
* Bearer Token
|
|
267
|
-
* @type {string}
|
|
268
|
-
* @memberof DocumentTemplatesApiListDocTemplates
|
|
269
|
-
*/
|
|
270
|
-
readonly authorization?: string;
|
|
271
260
|
/**
|
|
272
261
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
273
262
|
* @type {number}
|
|
274
263
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
275
264
|
*/
|
|
276
|
-
readonly pageSize
|
|
265
|
+
readonly pageSize: number;
|
|
277
266
|
/**
|
|
278
267
|
* 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.
|
|
279
268
|
* @type {string}
|
|
280
269
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
281
270
|
*/
|
|
282
|
-
readonly pageToken
|
|
271
|
+
readonly pageToken: string;
|
|
283
272
|
/**
|
|
284
273
|
* Filter response by productSlug, slug and name.
|
|
285
274
|
* @type {string}
|
|
286
275
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
287
276
|
*/
|
|
288
|
-
readonly filter
|
|
277
|
+
readonly filter: string;
|
|
289
278
|
/**
|
|
290
279
|
* Search document templates by name | slug
|
|
291
280
|
* @type {string}
|
|
292
281
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
293
282
|
*/
|
|
294
|
-
readonly search
|
|
283
|
+
readonly search: string;
|
|
295
284
|
/**
|
|
296
285
|
* Order response by createdAt.
|
|
297
286
|
* @type {string}
|
|
298
287
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
299
288
|
*/
|
|
300
|
-
readonly order
|
|
289
|
+
readonly order: string;
|
|
301
290
|
/**
|
|
302
291
|
* Expand response by bodyTemplate.
|
|
303
292
|
* @type {string}
|
|
304
293
|
* @memberof DocumentTemplatesApiListDocTemplates
|
|
305
294
|
*/
|
|
306
|
-
readonly expand
|
|
295
|
+
readonly expand: string;
|
|
296
|
+
/**
|
|
297
|
+
* Bearer Token
|
|
298
|
+
* @type {string}
|
|
299
|
+
* @memberof DocumentTemplatesApiListDocTemplates
|
|
300
|
+
*/
|
|
301
|
+
readonly authorization?: string;
|
|
307
302
|
}
|
|
308
303
|
/**
|
|
309
304
|
* Request parameters for updateDocTemplate operation in DocumentTemplatesApi.
|
|
@@ -345,7 +340,7 @@ export declare class DocumentTemplatesApi extends BaseAPI {
|
|
|
345
340
|
* @throws {RequiredError}
|
|
346
341
|
* @memberof DocumentTemplatesApi
|
|
347
342
|
*/
|
|
348
|
-
createDocTemplate(requestParameters: DocumentTemplatesApiCreateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
343
|
+
createDocTemplate(requestParameters: DocumentTemplatesApiCreateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
349
344
|
/**
|
|
350
345
|
* Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
|
|
351
346
|
* @summary Delete the document template
|
|
@@ -354,25 +349,25 @@ export declare class DocumentTemplatesApi extends BaseAPI {
|
|
|
354
349
|
* @throws {RequiredError}
|
|
355
350
|
* @memberof DocumentTemplatesApi
|
|
356
351
|
*/
|
|
357
|
-
deleteDocTemplate(requestParameters: DocumentTemplatesApiDeleteDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
352
|
+
deleteDocTemplate(requestParameters: DocumentTemplatesApiDeleteDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
358
353
|
/**
|
|
359
|
-
* Retrieves the details of the document template that was previously created.
|
|
354
|
+
* 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.
|
|
360
355
|
* @summary Retrieve the document template
|
|
361
356
|
* @param {DocumentTemplatesApiGetDocTemplateRequest} requestParameters Request parameters.
|
|
362
357
|
* @param {*} [options] Override http request option.
|
|
363
358
|
* @throws {RequiredError}
|
|
364
359
|
* @memberof DocumentTemplatesApi
|
|
365
360
|
*/
|
|
366
|
-
getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
361
|
+
getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
367
362
|
/**
|
|
368
|
-
* 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.
|
|
369
364
|
* @summary List document templates
|
|
370
365
|
* @param {DocumentTemplatesApiListDocTemplatesRequest} requestParameters Request parameters.
|
|
371
366
|
* @param {*} [options] Override http request option.
|
|
372
367
|
* @throws {RequiredError}
|
|
373
368
|
* @memberof DocumentTemplatesApi
|
|
374
369
|
*/
|
|
375
|
-
listDocTemplates(requestParameters
|
|
370
|
+
listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
376
371
|
/**
|
|
377
372
|
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
378
373
|
* @summary Update the document template
|
|
@@ -381,5 +376,5 @@ export declare class DocumentTemplatesApi extends BaseAPI {
|
|
|
381
376
|
* @throws {RequiredError}
|
|
382
377
|
* @memberof DocumentTemplatesApi
|
|
383
378
|
*/
|
|
384
|
-
updateDocTemplate(requestParameters: DocumentTemplatesApiUpdateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
379
|
+
updateDocTemplate(requestParameters: DocumentTemplatesApiUpdateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
385
380
|
}
|
|
@@ -194,15 +194,15 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
194
194
|
});
|
|
195
195
|
},
|
|
196
196
|
/**
|
|
197
|
-
* Retrieves the details of the document template that was previously created.
|
|
197
|
+
* 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.
|
|
198
198
|
* @summary Retrieve the document template
|
|
199
199
|
* @param {number} id
|
|
200
|
+
* @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.
|
|
200
201
|
* @param {string} [authorization] Bearer Token
|
|
201
|
-
* @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.
|
|
202
202
|
* @param {*} [options] Override http request option.
|
|
203
203
|
* @throws {RequiredError}
|
|
204
204
|
*/
|
|
205
|
-
getDocTemplate: function (id,
|
|
205
|
+
getDocTemplate: function (id, expand, authorization, options) {
|
|
206
206
|
if (options === void 0) { options = {}; }
|
|
207
207
|
return __awaiter(_this, void 0, void 0, function () {
|
|
208
208
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -211,6 +211,8 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
211
211
|
case 0:
|
|
212
212
|
// verify required parameter 'id' is not null or undefined
|
|
213
213
|
(0, common_1.assertParamExists)('getDocTemplate', 'id', id);
|
|
214
|
+
// verify required parameter 'expand' is not null or undefined
|
|
215
|
+
(0, common_1.assertParamExists)('getDocTemplate', 'expand', expand);
|
|
214
216
|
localVarPath = "/documentservice/v1/doc-templates/{id}"
|
|
215
217
|
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
216
218
|
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -246,25 +248,37 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
246
248
|
});
|
|
247
249
|
},
|
|
248
250
|
/**
|
|
249
|
-
* Returns a list of document templates you have previously created.
|
|
251
|
+
* 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.
|
|
250
252
|
* @summary List document templates
|
|
253
|
+
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
254
|
+
* @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.
|
|
255
|
+
* @param {string} filter Filter response by productSlug, slug and name.
|
|
256
|
+
* @param {string} search Search document templates by name | slug
|
|
257
|
+
* @param {string} order Order response by createdAt.
|
|
258
|
+
* @param {string} expand Expand response by bodyTemplate.
|
|
251
259
|
* @param {string} [authorization] Bearer Token
|
|
252
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
253
|
-
* @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.
|
|
254
|
-
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
255
|
-
* @param {string} [search] Search document templates by name | slug
|
|
256
|
-
* @param {string} [order] Order response by createdAt.
|
|
257
|
-
* @param {string} [expand] Expand response by bodyTemplate.
|
|
258
260
|
* @param {*} [options] Override http request option.
|
|
259
261
|
* @throws {RequiredError}
|
|
260
262
|
*/
|
|
261
|
-
listDocTemplates: function (
|
|
263
|
+
listDocTemplates: function (pageSize, pageToken, filter, search, order, expand, authorization, options) {
|
|
262
264
|
if (options === void 0) { options = {}; }
|
|
263
265
|
return __awaiter(_this, void 0, void 0, function () {
|
|
264
266
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
265
267
|
return __generator(this, function (_a) {
|
|
266
268
|
switch (_a.label) {
|
|
267
269
|
case 0:
|
|
270
|
+
// verify required parameter 'pageSize' is not null or undefined
|
|
271
|
+
(0, common_1.assertParamExists)('listDocTemplates', 'pageSize', pageSize);
|
|
272
|
+
// verify required parameter 'pageToken' is not null or undefined
|
|
273
|
+
(0, common_1.assertParamExists)('listDocTemplates', 'pageToken', pageToken);
|
|
274
|
+
// verify required parameter 'filter' is not null or undefined
|
|
275
|
+
(0, common_1.assertParamExists)('listDocTemplates', 'filter', filter);
|
|
276
|
+
// verify required parameter 'search' is not null or undefined
|
|
277
|
+
(0, common_1.assertParamExists)('listDocTemplates', 'search', search);
|
|
278
|
+
// verify required parameter 'order' is not null or undefined
|
|
279
|
+
(0, common_1.assertParamExists)('listDocTemplates', 'order', order);
|
|
280
|
+
// verify required parameter 'expand' is not null or undefined
|
|
281
|
+
(0, common_1.assertParamExists)('listDocTemplates', 'expand', expand);
|
|
268
282
|
localVarPath = "/documentservice/v1/doc-templates";
|
|
269
283
|
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
270
284
|
if (configuration) {
|
|
@@ -419,20 +433,20 @@ var DocumentTemplatesApiFp = function (configuration) {
|
|
|
419
433
|
});
|
|
420
434
|
},
|
|
421
435
|
/**
|
|
422
|
-
* Retrieves the details of the document template that was previously created.
|
|
436
|
+
* 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.
|
|
423
437
|
* @summary Retrieve the document template
|
|
424
438
|
* @param {number} id
|
|
439
|
+
* @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.
|
|
425
440
|
* @param {string} [authorization] Bearer Token
|
|
426
|
-
* @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.
|
|
427
441
|
* @param {*} [options] Override http request option.
|
|
428
442
|
* @throws {RequiredError}
|
|
429
443
|
*/
|
|
430
|
-
getDocTemplate: function (id,
|
|
444
|
+
getDocTemplate: function (id, expand, authorization, options) {
|
|
431
445
|
return __awaiter(this, void 0, void 0, function () {
|
|
432
446
|
var localVarAxiosArgs;
|
|
433
447
|
return __generator(this, function (_a) {
|
|
434
448
|
switch (_a.label) {
|
|
435
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocTemplate(id,
|
|
449
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocTemplate(id, expand, authorization, options)];
|
|
436
450
|
case 1:
|
|
437
451
|
localVarAxiosArgs = _a.sent();
|
|
438
452
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -441,24 +455,24 @@ var DocumentTemplatesApiFp = function (configuration) {
|
|
|
441
455
|
});
|
|
442
456
|
},
|
|
443
457
|
/**
|
|
444
|
-
* Returns a list of document templates you have previously created.
|
|
458
|
+
* 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.
|
|
445
459
|
* @summary List document templates
|
|
460
|
+
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
461
|
+
* @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.
|
|
462
|
+
* @param {string} filter Filter response by productSlug, slug and name.
|
|
463
|
+
* @param {string} search Search document templates by name | slug
|
|
464
|
+
* @param {string} order Order response by createdAt.
|
|
465
|
+
* @param {string} expand Expand response by bodyTemplate.
|
|
446
466
|
* @param {string} [authorization] Bearer Token
|
|
447
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
448
|
-
* @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.
|
|
449
|
-
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
450
|
-
* @param {string} [search] Search document templates by name | slug
|
|
451
|
-
* @param {string} [order] Order response by createdAt.
|
|
452
|
-
* @param {string} [expand] Expand response by bodyTemplate.
|
|
453
467
|
* @param {*} [options] Override http request option.
|
|
454
468
|
* @throws {RequiredError}
|
|
455
469
|
*/
|
|
456
|
-
listDocTemplates: function (
|
|
470
|
+
listDocTemplates: function (pageSize, pageToken, filter, search, order, expand, authorization, options) {
|
|
457
471
|
return __awaiter(this, void 0, void 0, function () {
|
|
458
472
|
var localVarAxiosArgs;
|
|
459
473
|
return __generator(this, function (_a) {
|
|
460
474
|
switch (_a.label) {
|
|
461
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDocTemplates(
|
|
475
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDocTemplates(pageSize, pageToken, filter, search, order, expand, authorization, options)];
|
|
462
476
|
case 1:
|
|
463
477
|
localVarAxiosArgs = _a.sent();
|
|
464
478
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -521,32 +535,32 @@ var DocumentTemplatesApiFactory = function (configuration, basePath, axios) {
|
|
|
521
535
|
return localVarFp.deleteDocTemplate(id, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
522
536
|
},
|
|
523
537
|
/**
|
|
524
|
-
* Retrieves the details of the document template that was previously created.
|
|
538
|
+
* 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.
|
|
525
539
|
* @summary Retrieve the document template
|
|
526
540
|
* @param {number} id
|
|
541
|
+
* @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.
|
|
527
542
|
* @param {string} [authorization] Bearer Token
|
|
528
|
-
* @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.
|
|
529
543
|
* @param {*} [options] Override http request option.
|
|
530
544
|
* @throws {RequiredError}
|
|
531
545
|
*/
|
|
532
|
-
getDocTemplate: function (id,
|
|
533
|
-
return localVarFp.getDocTemplate(id,
|
|
546
|
+
getDocTemplate: function (id, expand, authorization, options) {
|
|
547
|
+
return localVarFp.getDocTemplate(id, expand, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
534
548
|
},
|
|
535
549
|
/**
|
|
536
|
-
* Returns a list of document templates you have previously created.
|
|
550
|
+
* 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.
|
|
537
551
|
* @summary List document templates
|
|
552
|
+
* @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
553
|
+
* @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.
|
|
554
|
+
* @param {string} filter Filter response by productSlug, slug and name.
|
|
555
|
+
* @param {string} search Search document templates by name | slug
|
|
556
|
+
* @param {string} order Order response by createdAt.
|
|
557
|
+
* @param {string} expand Expand response by bodyTemplate.
|
|
538
558
|
* @param {string} [authorization] Bearer Token
|
|
539
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
540
|
-
* @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.
|
|
541
|
-
* @param {string} [filter] Filter response by productSlug, slug and name.
|
|
542
|
-
* @param {string} [search] Search document templates by name | slug
|
|
543
|
-
* @param {string} [order] Order response by createdAt.
|
|
544
|
-
* @param {string} [expand] Expand response by bodyTemplate.
|
|
545
559
|
* @param {*} [options] Override http request option.
|
|
546
560
|
* @throws {RequiredError}
|
|
547
561
|
*/
|
|
548
|
-
listDocTemplates: function (
|
|
549
|
-
return localVarFp.listDocTemplates(
|
|
562
|
+
listDocTemplates: function (pageSize, pageToken, filter, search, order, expand, authorization, options) {
|
|
563
|
+
return localVarFp.listDocTemplates(pageSize, pageToken, filter, search, order, expand, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
550
564
|
},
|
|
551
565
|
/**
|
|
552
566
|
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -599,7 +613,7 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
|
|
|
599
613
|
return (0, exports.DocumentTemplatesApiFp)(this.configuration).deleteDocTemplate(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
600
614
|
};
|
|
601
615
|
/**
|
|
602
|
-
* Retrieves the details of the document template that was previously created.
|
|
616
|
+
* 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.
|
|
603
617
|
* @summary Retrieve the document template
|
|
604
618
|
* @param {DocumentTemplatesApiGetDocTemplateRequest} requestParameters Request parameters.
|
|
605
619
|
* @param {*} [options] Override http request option.
|
|
@@ -608,10 +622,10 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
|
|
|
608
622
|
*/
|
|
609
623
|
DocumentTemplatesApi.prototype.getDocTemplate = function (requestParameters, options) {
|
|
610
624
|
var _this = this;
|
|
611
|
-
return (0, exports.DocumentTemplatesApiFp)(this.configuration).getDocTemplate(requestParameters.id, requestParameters.
|
|
625
|
+
return (0, exports.DocumentTemplatesApiFp)(this.configuration).getDocTemplate(requestParameters.id, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
612
626
|
};
|
|
613
627
|
/**
|
|
614
|
-
* Returns a list of document templates you have previously created.
|
|
628
|
+
* 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.
|
|
615
629
|
* @summary List document templates
|
|
616
630
|
* @param {DocumentTemplatesApiListDocTemplatesRequest} requestParameters Request parameters.
|
|
617
631
|
* @param {*} [options] Override http request option.
|
|
@@ -620,8 +634,7 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
|
|
|
620
634
|
*/
|
|
621
635
|
DocumentTemplatesApi.prototype.listDocTemplates = function (requestParameters, options) {
|
|
622
636
|
var _this = this;
|
|
623
|
-
|
|
624
|
-
return (0, exports.DocumentTemplatesApiFp)(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
637
|
+
return (0, exports.DocumentTemplatesApiFp)(this.configuration).listDocTemplates(requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
625
638
|
};
|
|
626
639
|
/**
|
|
627
640
|
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|